Shopify Hydrogen

This guide shows you how to deploy a Shopify Hydrogen application on Edgio.

You’ve installed the following dependencies:

Yarn version 1.x or npm

Node.js version 16.5.0 or higher

Edgio Applications’s support for Node.js version 16 is undergoing end-of-life. View the end-of-life plan.

Deploying requires an account on Edgio. Sign up here for free.

Install the Edgio CLI

If you have not already done so, install the Edgio CLI

Bash
npm i -g @layer0/cli # yarn global add @layer0/cli

Create a new Shopify Hydrogen app

If you don’t already have a Shopify Hydrogen app, create one by running the following:

Bashnpm
# JavaScript template
npm init @shopify/hydrogen -- --template demo-store-js

OR

# TypeScript template
npm init @shopify/hydrogen -- --template demo-store-ts

Bashyarn
# JavaScript template
yarn create @shopify/hydrogen --template demo-store-js

OR

# TypeScript template
yarn create @shopify/hydrogen --template demo-store-ts

You can verify your app works by running it locally with:

1npm run dev

Enable Server Side Rendering

To enable server side rendering with your Shopify Hydrogen app, build it with target set to node with command as:

Bash
npm run build -- --target node

OR

yarn build --target node

The production version of your app will be running at http://localhost:3000. You can inspect and deploy the compiled version of your Node.js Hydrogen storefront from dist/node.

NOTE: This step will be auto configured when building with Edgio as you follow the next steps.

Apply middleware

Create a server.js at the root of your project consisting of the following:

JavaScriptserver.js
const {createServer} = require('./dist/node');

createServer().then(({app}) => {
  app.listen(process.env.PORT || 3000, () => {
    console.log(`Server ready`);
  });
});

Configuring your Shopify Hydrogen app for Edgio

Initialize your project

In the root directory of your project run 0 init:

10 init

This will automatically update your package.json and add all of the required Edgio dependencies and files to your project. These include:

The @layer0/core package - Allows you to declare routes and deploy your application on Edgio
The @layer0/prefetch package - Allows you to configure a service worker to prefetch and cache pages to improve browsing speed
layer0.config.js - A configuration file for Edgio
routes.js - A default routes file that sends all requests to Shopify Hydrogen.

Update Edgio Configuration

Update layer0.config.js at the root of your project to the following:

JavaScript
// This file was automatically added by layer0 deploy.
// You should commit this file to source control.
module.exports = {
  connector: './layer0'
}

Creating Edgio connector files

Install @vercel/nft for Node.js File Tracing, by the following command:
Bash
1npm install @vercel/nft
2
3OR
4
5yarn add @vercel/nft

Create a folder named layer0 at the root of your project.

Create a file inside the layer0 folder, named build.js consistng of the following:

JavaScriptlayer0/build.js
const {join} = require('path');
  const {exit} = require('process');
  const {nodeFileTrace} = require('@vercel/nft');
  const {DeploymentBuilder} = require('@layer0/core/deploy');
  const {isYarn} = require('@layer0/cli/utils/packageManager');

  const appDir = process.cwd();
  const builder = new DeploymentBuilder(appDir);

  module.exports = async function build(options) {
    try {
      builder.clearPreviousBuildOutput();
      let command = 'npm run build -- --target node';
      if (isYarn()) {
        command = 'yarn build --target node';
      }
      await builder.exec(command);
      builder.addJSAsset(join(appDir, 'dist'));
      builder.addJSAsset(join(appDir, 'server.js'));
      // Determine the node_modules to include
      let dictNodeModules = await getNodeModules();
      Object.keys(dictNodeModules).forEach(async (i) => {
        await builder.addJSAsset(`${appDir}/${i}`);
      });
      await builder.build();
    } catch (e) {
      console.log(e);
      exit();
    }
  };

  async function getNodeModules() {
    // The whole app inside index.js
    const files = ['./dist/node/index.js'];
    // Compute file trace
    const {fileList} = await nodeFileTrace(files);
    // Store set of packages
    let packages = {};
    fileList.forEach((i) => {
      if (i.includes('node_modules/')) {
        let temp = i.replace('node_modules/', '');
        temp = temp.substring(0, temp.indexOf('/'));
        packages[`node_modules/${temp}`] = true;
      } else {
        packages[i] = true;
      }
    });
    // Sort the set of packages
    return Object.keys(packages)
      .sort()
      .reduce((obj, key) => {
        obj[key] = packages[key];
        return obj;
      }, {});
  }

Create a file named prod.js consistng of the following:

JavaScriptlayer0/prod.js
module.exports = async function prod(port) {
    process.env.PORT = port;
    await import('../server.js');
  };

Configure the routes

Update routes.js at the root of your project to the following:

JavaScript
// This file was added by layer0 init.
// You should commit this file to source control.
const ONE_HOUR = 60 * 60
const ONE_DAY = 24 * ONE_HOUR

const { Router } = require('@layer0/core/router')

module.exports = new Router()
  // Prevent search engine bot(s) from indexing
  // Read more on: https://docs.layer0.co/applications/cookbook#blocking-search-engine-crawlers
  .noIndexPermalink()
  .match('/assets/:path*', ({ cache }) => {
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
        forcePrivateCaching: true,
      },
      browser: {
        maxAgeSeconds: 0,
        serviceWorkerSeconds: ONE_DAY,
      },
    })
  })
  .match('/', ({ cache }) => {
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
      },
      browser: false,
    })
  })
  .match('/collections/:path*', ({ cache }) => {
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
      },
      browser: false,
    })
  })
  .match('/products/:path*', ({ cache }) => {
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
        forcePrivateCaching: true,
      },
      browser: {
        maxAgeSeconds: 0,
        serviceWorkerSeconds: ONE_DAY,
      },
    })
  })
  .fallback(({ renderWithApp }) => renderWithApp())

Refer to the Routing guide for the full syntax of the routes.js file and how to configure it for your use case.

Run the Shopify Hydrogen app locally on Edgio

Create a production build of your app by running the following in your project’s root directory:

10 build

Run Edgio on your local machine:

10 run --production

Load the site http://127.0.0.1:3000

Deploying

Create a production build of your app by running the following in your project’s root directory:

10 build

Next, deploy the build to Edgio by running the 0 deploy command:

10 deploy

Refer to the Deploying guide for more information on the deploy command and its options.

Shopify Hydrogen

Example