Skip to content

Latest commit

 

History

History
239 lines (160 loc) · 9.73 KB

README.md

File metadata and controls

239 lines (160 loc) · 9.73 KB
Raw

Shopify NextJS Toolbox

A set of server side and client side NextJs utilities for integrating with Shopify's OAuth & App Bridge authentication systems.

These tools will allow you to complete all steps for Shopify's new authentication system without Koa.js.

This package includes the following tools:

Server Side

Middleware

  • handleAuthStart - for handling the first step of the Shopify OAuth handshake and redirecting back to Shopify with access scope requests
  • handleAuthCallback - for handling the second step of the Shopify OAuth handshake and retrieving the merchant's access token
  • withSessionToken - for verifying the Authorization HTTP header containing the frontend generated Session Token

Redirect to a custom URL after OAuth

By default handleAuthCallback assumes that after a user has accepted your app's scopes it will redirect the user back to the path defined in the HOME_PATH environment variable. No need to return a string or use res.redirect inside of the handleAuthCallback.

However, if your app prompts for a payment plan immediately on install, you'll need to redirect them to the payment plan's confirmation URL at runtime.

To do this, simply return the URL in string format from handleAuthCallback and it will redirect the user to that URL instead of the URL defined in HOME_PATH.

// pages/api/auth/callback.js
import { handleAuthCallback } from 'shopify-nextjs-toolbox';

const afterAuth = async(req, res, accessToken) => {
  // save accessToken with the shop

  //present user with billing options
  const subscriptionUrl = await getSubscriptionUrl(
    accessToken,
    shop,
    ...
  );

  // the subscriptionUrl overrides redirecting to the HOME_PATH
  return subscriptionUrl;
};

export default handleAuthCallback(afterAuth);

Validating Nonce during OAuth handshake.

It is recommended that you use and validate a state parameter (also called a nonce) during the OAuth handshake. By default, handleAuthStart generates a random nonce for you, but does not store it for you. The database decision is left to you.

Read more about nonce verification on the Shopify Authentication Docs and the state parameter on the OAuth 2 RFC.

To save the generated own nonce during the inital OAuth URL generation, provide an async function saveNonce as an option to handleAuthStart:

import { handleAuthStart } from "shopify-nextjs-toolbox";

const saveNonce = async ({ req, shopName, nonce }) => {
  // associate the nonce in your database with the shopName for later retrieval in the OAuth callback
};

export default handleAuthStart({ saveNonce });

To validate the nonce on the callback, provide an async function validateNonce as an option to handleAuthCallback:

import { handleAuthCallback } from 'shopify-nextjs-toolbox';

const afterAuth = async(req, res, accessToken) => {
 ...
};

const validateNonce = async ({ nonce, req, shopName }) => {
  // retrieve the nonce associated with shopName from your database from `saveNonce` earlier
  // validate they are the same
  // below is totally pseudocode, but you get the idea
  const savedNonce = await db.getShop({ name: shopName }).nonce;

  return nonce === savedNonce;
}

export default handleAuthCallback(afterAuth, { validateNonce })

Note: validating nonces are optional for OAuth. If this is confusing, you can simply omit saveNonce and validateNonce from the middlewares as arguments, but it is recommended as a security step to validate the nonce to prove Shopify's identity.

Client Side

Components

  • ShopifyAppBridgeProvider - this component will act as the gatekeeper to your app. It will automatically store the host and shop parameters and pass them along to AppBridge during instantiation at the very end of OAuth.

Hooks

  • useOAuth - for automatically calling the /api/auth.js route to generate the URL to begin the OAuth handshake. Automatically redirects to the merchant to it as well.
  • useApi - for creating an axios instance that automatically adds the session token (Authorization: Bearer <token here>) to every HTTP request
  • useShopOrigin - for retrieving the shopOrigin query string parameter given by Shopify from the URL
  • useHost - for retrieving the host query string parameter given by Shopify from the URL

How to integrate Shopify's OAuth with a NextJs project

View the corresponding Shopify NextJs repository for a complete implementation example.

Specifically these files:

  • /pages/_app.js
  • /pages/index.js
  • /pages/api/auth.js
  • /pages/api/auth/callback.js

How to integrate Shopify's App Bridge Session Tokens with a NextJs Project

View the corresponding Shopify NextJs repository for a complete implementation example.

Remember session token generation occurs after the OAuth handshake. So these components & pages are triggered after OAuth and the user has been redirected to pages/home.js.

  • /pages/_app.js
  • /pages/home.js
  • /pages/api/verify-token.js

Frequently Asked Questions

I'm trying to deploy my Shopify NextJS app to Vercel, but I can't use an extra server like Koa to deploy. Can I use this package instead?

That's right. This package only uses NextJS API routing. There is no extra server needed. You'll be able to deploy to Vercel using the shopify-nextjs-toolbox package for handling your authentication.

I'm trying to migrate my app off of the cookie based authentication and to session tokens, will this do that?

Also correct, you can use the middleware and hooks provided by shopify-nextjs-toolbox to do so.

Do I need to store the shopOrigin variable in localStorage in order to use this?

No, the useShopOrigin hook will take care of storing the shop's origin (a.k.a. the primary ID of the shop within Shopify, looks like shop-name.myshopify.com). If you need to use the shop's primary ID elsewhere in the frontend you can do so with useShopifyOrigin.

Do I need to use useShopOrigin to make API requests back to my API?

No, that's the nice part about Shopify's Session Tokens. The shop's name is actually encoded in the session token. The withSessionToken middleware will automatically populate the req.shopName with the shop's unique Shopify name.

You don't need to pass the shop name to the API manually. Simply use the useApi hook to create the API client and it will handle passing the session token to your API in the Authorization header.

Migrating from v1 to v2

The original shopify-nextjs-toolbox package was compatible with AppBridge v1. AppBridge v2 has seen been released and is required for all new apps, and starting Jan 1st 2022 it will be required for all Shopify apps to use AppBridge v2.

If you're using shopify-nextjs-toolbox version 1.x, here's how to use the new v2.

1. Update your frontend index page to use the new useOAuth hook:

// pages/index.js

import React, { useEffect } from "react";
import { useOAuth } from "shopify-nextjs-toolbox";

export default function Index() {
  // if the current user isn't logged in, redirect them to begin OAuth on Shopify
  useOAuth();

  // replace this with your jazzy loading icon animation
  return <>Loading...</>;
}

2. Replace Shopify's <Provider> with the included <ShopifyAppBridgeProvider>

import { ShopifyAppBridgeProvider } from "shopify-nextjs-toolbox";
import { Provider } from "@shopify/app-bridge-react";
import enTranslations from "@shopify/polaris/locales/en.json";
import { AppProvider } from "@shopify/polaris";

function MyApp({ Component, pageProps }) {
  // The ShopifyAppBridgeProvider abstracts starting the OAuth process
  //   it will automatically redirect unauthenticated users to your `/api/auth.js` route
  //   note: the "appBridgeConfig" is just a way to pass AppBridge options, by default we'll handle passing the host in for you
  return (
    <ShopifyAppBridgeProvider
      Component={Component}
      pageProps={pageProps}
      appBridgeConfig={{}}
    >
      <AppProvider i18n={enTranslations}>
        <Component {...pageProps} />
      </AppProvider>
    </ShopifyAppBridgeProvider>
  );
}

export default MyApp;

3. (Optional) implement a nonce at the start of the OAuth process

// pages/api/auth.js

import { handleAuthStart } from "shopify-nextjs-toolbox";

const saveNonce = async ({ req, shopName, nonce }) => {
  // shopify-nextjs-toolbox does the work of generating a secure unique nonce
  //   for better security, associate this nonce with the shop
  //
  // Example:
  // await db.connect().collection('nonces').insertOne({ shopName, nonce });
};

export default handleAuthStart({ saveNonce });

3. (Optional) validate the nonce at the end of the OAuth process

// pages/api/auth/callback.js

import { handleAuthCallback } from "shopify-nextjs-toolbox";

const validateNonce = async ({ req, shopName, nonce }) => {
  // retrieve the nonce associated with the current shop from OAuth
  // validate the nonce passed into this argument matches that nonce
};

const afterAuth = async (req, res, tokenData) => {
  const shop = req.query.shop;
  const accessToken = tokenData.access_token;

  // save the accessToken with the shop in your database to interact with the Shopify Admin API
};

export default handleAuthCallback(afterAuth, { options: { validateNonce } });

4. useApi doesn't require a token any longer

// now you can use useApi() without any arguments, it infers the session token from the AppBridge context under the hood.
const api = useApi();

const { data } = await api.get("/api/shop");