unsweets.log

Frontend & Android.

nuxt-payload-extractorでクライアントナビゲーション時の無駄なfetchを避ける

Published at

小並感こと私生活を書いてるブログを Ghost で運用していましたが、運用していたサーバーがあまり性能がいいものではないのでフロント部分を Netlify に移し、Headless CMS として運用するようにしました。

構成

  • Netlify(フロント)
  • Ghost(バック)
  • GitHub(リポジトリ)

リポジトリにフロント部分のコードの更新か Ghost からのブログ再構築 Webhook を Netlify が検知することでビルド・デプロイを行っています。

フロント側は Nuxt のnuxt generateコマンドを利用して HTML コンテンツを吐き出すようにしました。

コンテンツを完全に静的生成にする

記事ページ中などで ghostAPI にアクセスしてコンテンツを取得するとき当初このようにしました。

{
  asyncData(app: { $axios }) {
    return $axios.$get('/article')
  }
}

上記は実際のところクライアントナビゲーション時に再度 fetch しに行っています。node.js でのコンテンツ生成時(nuxt generate)は SSR 同様 axios でコンテンツを取得しているので問題ないのですが、クライアントサイドナビゲーションでは静的生成された HTML を見てくれません。このままですとせっかく静的生成したにも関わらず API を叩いていてあまり意味がありません。また、静的生成された HTML の下部には同様のコンテンツをwindow.__NUXT__で持っていたりと、重複箇所が見受けられます。

これはnuxt-payload-extractorを使用することで解決します。window.__NUXT__部分を json として切り出した上、$payloadURL関数を提供し、route を与えることで切り出した json の URL を教えてくれます。

{
  async asyncData({ app: { $axios }, $payloadURL, route }) {
    if (process.static && process.client && $payloadURL) {
      return await $axios.$get($payloadURL(route))
    } else {
      const article = await $axios.$get('/article')
      return {
        article
      }
    }
  }
}

ページ数が少ない場合はこれで良いのですが、process.static && process.client && $payloadURL部分が冗長なので plugin を作って共通化するとコードを短く出来ます。

import { Plugin } from "@nuxt/types";
import { Route } from "vue-router";

const plugin: Plugin = (context) => {
  const cache: {
    [key: string]: object;
  } = {};
  const getPayload = async (callback: () => Promise<object> | object) => {
    if (!process.static || !process.client || !context.$payloadURL)
      return callback();
    const url = context.$payloadURL(context.route);
    if (cache[url]) return cache[url];
    const res: object = await fetch(url).then((res) => res.json());
    cache[url] = res;
    return res;
  };
  context.getPayload = getPayload;
};

declare module "@nuxt/types" {
  interface Context {
    $payloadURL(route: Route): string;
    getPayload(callback: () => Promise<object> | object): Promise<object>;
  }
}

export default plugin;

ついでにメモリキャッシュを実装してみました。2 回目以降は通信することなくページコンテンツの取得が可能です(axios がやってくれていそうですが)。

利用時は getPayload でラップし、通常通りコンテンツに流し込むデータを return するようにします。

{
  asyncData({ getPayload, app: { $axios } }) {
    return getPayload(async () => {
      return {
        article: await $axios.get('/article')
      }
    })
  }
}

こうすることで普段とあまり変わりなく asyncData での fetch に勤しむことができますね!


Created by _X_y_z_.