Pic-a-daily: тема 4 – создание клиентской части сайта

1. Обзор

В этой практической работе вы создадите веб-интерфейс в Google App Engine, который позволит пользователям загружать изображения из веб-приложения, а также просматривать загруженные изображения и их уменьшенные копии.

21741cd63b425aeb.png

В этом веб-приложении будет использоваться CSS-фреймворк Bulma, который позволяет создать привлекательный пользовательский интерфейс, а также JavaScript-фреймворк Vue.JS для вызова API приложения, которое вы создадите.

В приложении будет три вкладки:

  • Главная страница, на которой будут отображаться уменьшенные изображения всех загруженных изображений, а также список ярлыков, описывающих изображение (обнаруженных Cloud Vision API в предыдущей лабораторной работе).
  • Страница collage, на которой будет показываться коллаж из четырех последних загруженных изображений.
  • Страница загрузки, на которой пользователи могут загружать новые фотографии.

Вот как выглядит интерфейс:

6a4d5e5603ba4b73.png

Эти три страницы представляют собой простые HTML-страницы:

  • Главная страница (index.html) вызывает код серверной части Node App Engine, чтобы получить список уменьшенных изображений и их ярлыков, через вызов AJAX к URL /api/pictures. Для получения этих данных на главной странице используется Vue.js.
  • Страница collage (collage.html) указывает на изображение collage.png, которое собирает четыре последних изображения.
  • На странице upload (upload.html) есть простая форма для загрузки изображения с помощью запроса POST к URL /api/pictures.

Что вы узнаете

  • App Engine
  • Cloud Storage
  • Cloud Firestore

2. Настройка и требования

Самостоятельная настройка среды

  1. Войдите в консоль Google Cloud и создайте новый проект или используйте существующий. Если у вас нет аккаунта Gmail или Google Workspace, создайте его.

b35bf95b8bf3d5d8.pnga99b7ace416376c4.pngbd84a6d3004737c5.png

  • Название проекта – это отображаемое название для участников проекта. Это строка символов, которая не используется API Google. Ее можно изменить в любое время.
  • Идентификатор проекта должен быть уникальным для всех проектов Google Cloud и неизменным (его нельзя изменить после установки). Cloud Console автоматически генерирует уникальную строку. Обычно ее значение не имеет значения. В большинстве практических работ вам нужно будет ссылаться на идентификатор проекта (обычно он обозначается как PROJECT_ID), поэтому, если он вам не нравится, сгенерируйте другой случайный идентификатор или попробуйте использовать свой собственный и посмотрите, доступен ли он. После создания проекта изменить его идентификатор нельзя.
  • Есть и третье значение – номер проекта, который используется некоторыми API. Подробнее об этих трех значениях рассказывается в документации.
  1. Затем вам нужно будет включить платежи в Cloud Console, чтобы использовать ресурсы и API Cloud. Выполнение этой практической работы не должно стоить много, если вообще что-то стоит. Чтобы отключить ресурсы и не платить за них после завершения практической работы, следуйте инструкциям по очистке в конце практической работы. Новые пользователи Google Cloud могут воспользоваться бесплатной пробной версией с бонусом в размере 300 долларов США.

Запустите Cloud Shell

Хотя Google Cloud можно управлять удаленно с ноутбука, в этой практической работе вы будете использовать Google Cloud Shell – среду командной строки, работающую в облаке.

В консоли Google Cloud нажмите на значок Cloud Shell на панели инструментов в правом верхнем углу.

55efc1aaa7a4d3ad.png

Инициализация и подключение к среде займут всего несколько минут. После завершения вы увидите примерно следующее:

7ffe5cbb04455448.png

На этой виртуальной машине установлены все необходимые инструменты разработки. Она предлагает постоянный домашний каталог объемом 5 ГБ и работает на платформе Google Cloud, что значительно повышает производительность сети и аутентификацию. Для выполнения всех заданий этой лабораторной работы вам понадобится только браузер.

3. Как включить API

Для App Engine требуется Compute Engine API. Убедитесь, что он включен:

gcloud services enable compute.googleapis.com

Вы должны увидеть сообщение об успешном завершении операции:

Operation "operations/acf.5c5ef4f6-f734-455d-b2f0-ee70b5a17322" finished successfully.

4. Клонирование кода

Если вы ещё не получили код, сделайте это:

git clone https://github.com/GoogleCloudPlatform/serverless-photosharing-workshop

Затем перейдите в каталог, содержащий интерфейс:

cd serverless-photosharing-workshop/frontend

Для интерфейса у вас будет следующая структура файлов:

frontend
 |
 ├── index.js
 ├── package.json
 ├── app.yaml
 |
 ├── public
      |
      ├── index.html
      ├── collage.html
      ├── upload.html
      |
      ├── app.js
      ├── script.js
      ├── style.css

В корневом каталоге проекта есть три файла:

  • index.js содержит код Node.js.
  • package.json определяет зависимости библиотеки
  • app.yaml – это файл конфигурации для Google App Engine.

Папка public содержит статические ресурсы:

  • index.html – страница со всеми значками и ярлыками.
  • collage.html показывает коллаж из недавних фотографий
  • На странице upload.html есть форма для загрузки новых изображений.
  • app.js использует Vue.js для заполнения страницы index.html данными
  • script.js управляет меню навигации и его значком в виде трех горизонтальных полосок на небольших экранах.
  • style.css определяет некоторые директивы CSS

5. Изучите код

Зависимости

В файле package.json определены необходимые зависимости библиотек:

{
  "name": "frontend",
  "version": "0.0.1",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "@google-cloud/firestore": "^3.4.1",
    "@google-cloud/storage": "^4.0.0",
    "express": "^4.16.4",
    "dayjs": "^1.8.22",
    "bluebird": "^3.5.0",
    "express-fileupload": "^1.1.6"
  }
}

Наше приложение для телевизоров доступно на следующих устройствах:

  • firestore – для доступа к Cloud Firestore с метаданными изображений;
  • storage – для доступа к Google Cloud Storage, где хранятся изображения;
  • express – веб-фреймворк для Node.js;
  • dayjs – небольшая библиотека для показа дат в удобном для восприятия формате;
  • bluebird – библиотека JavaScript Promise;
  • express-fileupload – библиотека для удобной загрузки файлов.

Объявление Express, размещенное в интерфейсе

В начале контроллера index.js необходимо указать все зависимости, определенные ранее в package.json:

const express = require('express');
const fileUpload = require('express-fileupload');
const Firestore = require('@google-cloud/firestore');
const Promise = require("bluebird");
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const path = require('path');
const dayjs = require('dayjs');
const relativeTime = require('dayjs/plugin/relativeTime')
dayjs.extend(relativeTime)

Затем создается экземпляр приложения Express.

Используются два промежуточных ПО Express:

  • Вызов express.static() указывает, что статические ресурсы будут доступны в подкаталоге public.
  • А fileUpload() настраивает загрузку файлов, чтобы ограничить размер файла до 10 МБ, чтобы загрузить файлы локально в файловую систему в памяти в каталоге /tmp.
const app = express();
app.use(express.static('public'));
app.use(fileUpload({
    limits: { fileSize: 10 * 1024 * 1024 },
    useTempFiles : true,
    tempFileDir : '/tmp/'
}))

Среди статических ресурсов у вас есть HTML-файлы для главной страницы, страницы коллажа и страницы загрузки. Эти страницы будут вызывать серверную часть API. У этого API будут следующие конечные точки:

  • POST /api/pictures Изображения будут загружаться через форму в upload.html с помощью запроса POST.
  • GET /api/pictures Эта конечная точка возвращает документ JSON со списком изображений и их ярлыков.
  • GET /api/pictures/:name Этот URL перенаправляет на местоположение полноразмерного изображения в облачном хранилище.
  • GET /api/thumbnails/:name Этот URL перенаправляет на место хранения уменьшенного изображения в облаке.
  • GET /api/collage Последний URL перенаправляет в облачное хранилище, где находится сгенерированное изображение коллажа.

Загрузка изображения

Прежде чем изучать код Node.js для загрузки изображений, ознакомьтесь с public/upload.html.

... 
<form method="POST" action="/api/pictures" enctype="multipart/form-data">
    ... 
    <input type="file" name="pictures">
    <button>Submit</button>
    ... 
</form>
... 

Элемент формы указывает на конечную точку /api/pictures с методом HTTP POST и составным форматом. Теперь index.js должен ответить на эту конечную точку и метод и извлечь файлы:

app.post('/api/pictures', async (req, res) => {
    if (!req.files || Object.keys(req.files).length === 0) {
        console.log("No file uploaded");
        return res.status(400).send('No file was uploaded.');
    }
    console.log(`Receiving files ${JSON.stringify(req.files.pictures)}`);

    const pics = Array.isArray(req.files.pictures) ? req.files.pictures : [req.files.pictures];

    pics.forEach(async (pic) => {
        console.log('Storing file', pic.name);
        const newPicture = path.resolve('/tmp', pic.name);
        await pic.mv(newPicture);

        const pictureBucket = storage.bucket(process.env.BUCKET_PICTURES);
        await pictureBucket.upload(newPicture, { resumable: false });
    });


    res.redirect('/');
});

Сначала вы проверяете, действительно ли загружаются файлы. Затем вы скачиваете файлы локально с помощью метода mv из нашего модуля Node для загрузки файлов. Теперь, когда файлы доступны в локальной файловой системе, вы загружаете изображения в сегмент Cloud Storage. Наконец, вы перенаправляете пользователя обратно на главный экран приложения.

Составляю список изображений

Пора показать ваши прекрасные фотографии!

В обработчике /api/pictures вы заглядываете в коллекцию pictures базы данных Firestore, чтобы получить все изображения (для которых была создана уменьшенная копия), упорядоченные по убыванию даты создания.

Вы помещаете каждое изображение в массив JavaScript с его названием, описывающими его ярлыками (из Cloud Vision API), доминирующим цветом и понятной датой создания (с помощью dayjs мы получаем относительные смещения по времени, например "через 3 дня").

app.get('/api/pictures', async (req, res) => {
    console.log('Retrieving list of pictures');

    const thumbnails = [];
    const pictureStore = new Firestore().collection('pictures');
    const snapshot = await pictureStore
        .where('thumbnail', '==', true)
        .orderBy('created', 'desc').get();

    if (snapshot.empty) {
        console.log('No pictures found');
    } else {
        snapshot.forEach(doc => {
            const pic = doc.data();
            thumbnails.push({
                name: doc.id,
                labels: pic.labels,
                color: pic.color,
                created: dayjs(pic.created.toDate()).fromNow()
            });
        });
    }
    console.table(thumbnails);
    res.send(thumbnails);
});

Этот контроллер возвращает результаты следующей формы:

[
   {
      "name": "IMG_20180423_163745.jpg",
      "labels": [
         "Dish",
         "Food",
         "Cuisine",
         "Ingredient",
         "Orange chicken",
         "Produce",
         "Meat",
         "Staple food"
      ],
      "color": "#e78012",
      "created": "a day ago"
   },
   ...
]

Эта структура данных используется небольшим фрагментом Vue.js со страницы index.html. Ниже приведена упрощенная версия разметки с этой страницы.

<div id="app">
        <div class="container" id="app">
                <div id="picture-grid">
                        <div class="card" v-for="pic in pictures">
                                <div class="card-content">
                                        <div class="content">
                                                <div class="image-border" :style="{ 'border-color': pic.color }">
                                                        <a :href="'/api/pictures/' + pic.name">
                                                                <img :src="'/api/thumbnails/' + pic.name">
                                                        </a>
                                                </div>
                                                <a class="panel-block" v-for="label in pic.labels" :href="'/?q=' + label">
                                                        <span class="panel-icon">
                                                                <i class="fas fa-bookmark"></i> &nbsp;
                                                        </span>
                                                        {{ label }}
                                                </a>
                                        </div>
                                </div>
                        </div>
            </div>
        </div>
</div>

Идентификатор div указывает Vue.js, что эта часть разметки будет отображаться динамически. Итерации выполняются благодаря директивам v-for.

Изображения получают красивую цветную рамку, соответствующую доминирующему цвету на изображении, найденному с помощью Cloud Vision API, и мы указываем на миниатюры и полноразмерные изображения в источниках ссылок и изображений.

В конце мы перечисляем ярлыки, описывающие изображение.

Ниже приведен код JavaScript для фрагмента Vue.js (в файле public/app.js, импортированном в нижней части страницы index.html).

var app = new Vue({
  el: '#app',
  data() {
    return { pictures: [] }
  },
  mounted() {
    axios
      .get('/api/pictures')
      .then(response => { this.pictures = response.data })
  }
})

Код Vue использует библиотеку Axios для выполнения вызова AJAX к конечной точке /api/pictures. Возвращенные данные затем связываются с кодом представления в разметке, которую вы видели ранее.

Просмотр изображений

На index.html пользователи могут просматривать уменьшенные изображения и нажимать на них, чтобы увидеть полноразмерные. На collage.html пользователи видят collage.png изображение.

В HTML-разметке этих страниц изображение src и ссылка href указывают на эти три конечные точки, которые перенаправляют на местоположения Cloud Storage изображений, значков и коллажа. Вам не нужно задавать путь в коде HTML.

app.get('/api/pictures/:name', async (req, res) => {
    res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_PICTURES}/${req.params.name}`);
});

app.get('/api/thumbnails/:name', async (req, res) => {
    res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_THUMBNAILS}/${req.params.name}`);
});

app.get('/api/collage', async (req, res) => {
    res.redirect(`https://storage.cloud.google.com/${process.env.BUCKET_THUMBNAILS}/collage.png`);
});

Запуск приложения Node

После определения всех конечных точек приложение Node.js готово к запуску. Приложение Express по умолчанию прослушивает порт 8080 и готово к обработке входящих запросов.

const PORT = process.env.PORT || 8080;

app.listen(PORT, () => {
    console.log(`Started web frontend service on port ${PORT}`);
    console.log(`- Pictures bucket = ${process.env.BUCKET_PICTURES}`);
    console.log(`- Thumbnails bucket = ${process.env.BUCKET_THUMBNAILS}`);
});

6. Локальное тестирование

Протестируйте код локально, чтобы убедиться, что он работает, прежде чем развертывать его в облаке.

Вам нужно экспортировать две переменные среды, соответствующие двум сегментам Cloud Storage:

export BUCKET_THUMBNAILS=thumbnails-${GOOGLE_CLOUD_PROJECT}
export BUCKET_PICTURES=uploaded-pictures-${GOOGLE_CLOUD_PROJECT}

В папке frontend установите зависимости npm и запустите сервер:

npm install; npm start

Если все прошло успешно, сервер должен запуститься на порту 8080:

Started web frontend service on port 8080
- Pictures bucket = uploaded-pictures-${GOOGLE_CLOUD_PROJECT}
- Thumbnails bucket = thumbnails-${GOOGLE_CLOUD_PROJECT}

В этих журналах будут указаны настоящие названия сегментов, что может быть полезно при отладке.

В Cloud Shell можно использовать функцию предварительного просмотра в браузере, чтобы просматривать приложение, запущенное локально:

82fa3266d48c0d0a.png

Чтобы его отключить, используйте жест "CTRL-C".

7. Развернуть в App Engine

Приложение готово к развертыванию.

Настройка App Engine

Изучите файл конфигурации app.yaml для App Engine:

runtime: nodejs16
env_variables:
  BUCKET_PICTURES: uploaded-pictures-GOOGLE_CLOUD_PROJECT
  BUCKET_THUMBNAILS: thumbnails-GOOGLE_CLOUD_PROJECT

Первая строка указывает, что среда выполнения основана на Node.js 10. Определены две переменные среды, указывающие на два сегмента: для исходных изображений и для уменьшенных.

Чтобы заменить GOOGLE_CLOUD_PROJECT на идентификатор проекта, выполните следующую команду:

sed -i -e "s/GOOGLE_CLOUD_PROJECT/${GOOGLE_CLOUD_PROJECT}/" app.yaml

Развертывание

Установите предпочтительный регион для App Engine. Обязательно используйте тот же регион, что и в предыдущих практических работах:

gcloud config set compute/region europe-west1

И развертывание:

gcloud app deploy

Через пару минут вы увидите сообщение о том, что приложение обрабатывает трафик:

Beginning deployment of service [default]...
╔════════════════════════════════════════════════════════════╗
╠═ Uploading 8 files to Google Cloud Storage                ═╣
╚════════════════════════════════════════════════════════════╝
File upload done.
Updating service [default]...done.
Setting traffic split for service [default]...done.
Deployed service [default] to [https://GOOGLE_CLOUD_PROJECT.appspot.com]
You can stream logs from the command line by running:
  $ gcloud app logs tail -s default
To view your application in the web browser run:
  $ gcloud app browse

Вы также можете перейти в раздел App Engine в Cloud Console, чтобы убедиться, что приложение развернуто, и изучить функции App Engine, такие как управление версиями и разделение трафика.

db0e196b00fceab1.png

8. Протестируйте приложение

Чтобы проверить, все ли работает, перейдите по URL приложения App Engine по умолчанию (https://<YOUR_PROJECT_ID>.appspot.com/). Вы должны увидеть интерфейс приложения.

6a4d5e5603ba4b73.png

9. Очистка (необязательно)

Если вы не планируете использовать приложение, удалите проект, чтобы освободить ресурсы и сэкономить средства.

gcloud projects delete ${GOOGLE_CLOUD_PROJECT} 

10. Поздравляем!

Поздравляем! Это веб-приложение Node.js, размещенное в App Engine, связывает все ваши сервисы и позволяет пользователям загружать и просматривать изображения.

Что мы обсудили

  • App Engine
  • Cloud Storage
  • Cloud Firestore

Дальнейшие действия