Closed8

Loading chunk failed 対策調査まとめ

ハトすけハトすけ

Amplifyなどホスティングしたとに、Loading chunk 5 filed のようなエラーがでる。

原因は、webpackで生成するchunk fileのハッシュの値が、新しくビルドしたものと、古いもので異なるため。

特にReactでは、dynamic import において発生する。

ハトすけハトすけ

対応一覧

フロント側で対応する場合

window.onerrorで該当エラーをキャッチしたらreloadする。

reloadによってstateが消える可能性あり。
https://stackoverflow.com/questions/53704950/webpack-code-splitting-loading-chunk-failed-error-wrong-file-path

lazy loadingをretlyする。

reloadによってstateが消える可能性あり。
https://dev.to/goenning/how-to-retry-when-react-lazy-fails-mb5
https://mitchgavan.com/code-splitting-react-safely/

ServiceWorkerを利用する。

ServiceWorkerで各chunkファイルを事前にブラウザに保持しておく。これらはタブやブラウザが完全に閉じるまで保持される。新しいchunkを認識すると、次にユーザーに新しいバージョンに移行するように通知する。

サーバー側で対応する場合

サーバー側で古いchunkを捨てずに保持しておく。

古いchunkを要求されたらそれを返す。また新しいchunkがあるのに古いchunkを要求しようとすれば、ユーザーに新しいappに移行するように通知する(webであれば単純にreloadしてもらう)。多分、amplify consoleはこういうの対応してない。

そもそも、chunkファイル名にhashを利用しない。

-> キャッシュの設定によっては、内容が更新されているのに古いキャッシュが残ってしまうことも。あまり推奨されない。

ハトすけハトすけ

一番簡単なのは、lazy loadingのretry処理。
汎用的なのは、service workerでの事前キャッシュかな。

ハトすけハトすけ

実現コード。

App.tsx

const App: React.FC<MainProps> = ({ store }) => {
  /* ------------------------ */
  /*        新しいバージョン通知        */
  /* ------------------------ */
  // 参考: https://dev.to/daniellycosta/showing-new-version-available-notification-on-create-react-app-pwas-3jc9
  const [serviceWorkerState, setServiceWorkerState] = useState<{
    waitingWorker: ServiceWorker | null;
    isNewVersionAvailable: boolean;
  }>({
    waitingWorker: null,
    isNewVersionAvailable: false,
  });

  useEffect(() => {
    const onServiceWorkerUpdate = (registration: ServiceWorkerRegistration) => {
      setServiceWorkerState({
        waitingWorker: registration && registration.waiting,
        isNewVersionAvailable: true,
      });
    };

    serviceWorkerRegistration.register({
      onUpdate: onServiceWorkerUpdate,
    });
  }, []);

  useEffect(() => {
    const updateAction = () => {
      serviceWorkerState.waitingWorker?.postMessage({
        type: 'SKIP_WAITING',
      });
      setServiceWorkerState((prev) => ({
        ...prev,
        isNewVersionAvailable: false,
      }));
      window.location.reload();
    };

    const renderNotification = (onClose: () => void) => {
      return (
        <Button
          color="primary"
          size="sm"
          onClick={() => {
            updateAction();
            onClose();
          }}
        >
          リフレッシュ
        </Button>
      );
    };

    if (serviceWorkerState.isNewVersionAvailable) {
     // ユーザーに通知するトーストの表示
     // ここではreact-hot-toastを利用してる
      notify({
        status: 'custom',
        message: '新しいバージョンがリリースされました',
        renderCustom: renderNotification,
        preventDuplicateId: 'newVersionAvailable',
      });
    }
  }, [serviceWorkerState]);

  return (
    <div>hogehgoe</div>
  );
};
service-worker.ts
/// <reference lib="webworker" />

/* eslint-disable no-restricted-globals */
// This service worker can be customized!
// See https://developers.google.com/web/tools/workbox/modules
// for the list of available Workbox modules, or add any other
// code you'd like.
// You can also remove this file if you'd prefer not to use a
// service worker, and the Workbox build step will be skipped.
import { clientsClaim } from 'workbox-core';
import { ExpirationPlugin } from 'workbox-expiration';
import { precacheAndRoute, createHandlerBoundToURL } from 'workbox-precaching';
import { registerRoute } from 'workbox-routing';
import { StaleWhileRevalidate } from 'workbox-strategies';

declare const self: ServiceWorkerGlobalScope;

clientsClaim();

// Precache all of the assets generated by your build process.
// Their URLs are injected into the manifest variable below.
// This variable must be present somewhere in your service worker file,
// even if you decide not to use precaching. See https://cra.link/PWA
// eslint-disable-next-line no-underscore-dangle
precacheAndRoute(self.__WB_MANIFEST);

// Set up App Shell-style routing, so that all navigation requests
// are fulfilled with your index.html shell. Learn more at
// https://developers.google.com/web/fundamentals/architecture/app-shell
const fileExtensionRegexp = new RegExp('/[^/?]+\\.[^/]+$');
registerRoute(
  // Return false to exempt requests from being fulfilled by index.html.
  ({ request, url }: { request: Request; url: URL }) => {
    // If this isn't a navigation, skip.
    if (request.mode !== 'navigate') {
      return false;
    }

    // If this is a URL that starts with /_, skip.
    if (url.pathname.startsWith('/_')) {
      return false;
    }

    // If this looks like a URL for a resource, because it contains
    // a file extension, skip.
    if (url.pathname.match(fileExtensionRegexp)) {
      return false;
    }

    // Return true to signal that we want to use the handler.
    return true;
  },
  createHandlerBoundToURL(`${process.env.PUBLIC_URL}/index.html`),
);

// An example runtime caching route for requests that aren't handled by the
// precache, in this case same-origin .png requests like those from in public/
registerRoute(
  // Add in any other file extensions or routing criteria as needed.
  ({ url }) =>
    url.origin === self.location.origin && url.pathname.endsWith('.png'),
  // Customize this strategy as needed, e.g., by changing to CacheFirst.
  new StaleWhileRevalidate({
    cacheName: 'images',
    plugins: [
      // Ensure that once this runtime cache reaches a maximum size the
      // least-recently used images are removed.
      new ExpirationPlugin({ maxEntries: 50 }),
    ],
  }),
);

// This allows the web app to trigger skipWaiting via
// registration.waiting.postMessage({type: 'SKIP_WAITING'})
self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'SKIP_WAITING') {
    self.skipWaiting();
  }
});

// Any other custom service worker logic can go here.
serviceWorkerRegistration.ts
// This optional code is used to register a service worker.
// register() is not called by default.
// This lets the app load faster on subsequent visits in production, and gives
// it offline capabilities. However, it also means that developers (and users)
// will only see deployed updates on subsequent visits to a page, after all the
// existing tabs open on the page have been closed, since previously cached
// resources are updated in the background.
// To learn more about the benefits of this model and instructions on how to
// opt-in, read https://bit.ly/CRA-PWA

/* eslint func-style: 'off' */

/* eslint no-param-reassign: 'off' */

/* eslint no-use-before-define: 'off' */

/* eslint '@typescript-eslint/no-use-before-define': 'off' */
import { Logger } from '@aws-amplify/core';

const logger = new Logger('serviceWorker');

const isLocalhost = Boolean(
  window.location.hostname === 'localhost' ||
    // [::1] is the IPv6 localhost address.
    window.location.hostname === '[::1]' ||
    // 127.0.0.0/8 are considered localhost for IPv4.
    window.location.hostname.match(
      /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/,
    ),
);

type Config = {
  onSuccess?: (registration: ServiceWorkerRegistration) => void;
  onUpdate?: (registration: ServiceWorkerRegistration) => void;
};

export function register(config?: Config): void {
  if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
    // The URL constructor is available in all browsers that support SW.
    const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
    if (publicUrl.origin !== window.location.origin) {
      // Our service worker won't work if PUBLIC_URL is on a different origin
      // from what our page is served on. This might happen if a CDN is used to
      // serve assets; see https://github.com/facebook/create-react-app/issues/2374
      return;
    }

    window.addEventListener('load', () => {
      const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;

      if (isLocalhost) {
        // This is running on localhost. Let's check if a service worker still exists or not.
        checkValidServiceWorker(swUrl, config);

        // Add some additional logging to localhost, pointing developers to the
        // service worker/PWA documentation.
        navigator.serviceWorker.ready.then(() => {
          logger.log(
            'This web app is being served cache-first by a service ' +
              'worker. To learn more, visit https://bit.ly/CRA-PWA',
          );
        });
      } else {
        // Is not localhost. Just register service worker
        registerValidSW(swUrl, config);
      }
    });
  }
}

function registerValidSW(swUrl: string, config?: Config) {
  navigator.serviceWorker
    .register(swUrl)
    .then((registration) => {
      registration.onupdatefound = () => {
        const installingWorker = registration.installing;
        if (installingWorker == null) {
          return;
        }
        installingWorker.onstatechange = () => {
          if (installingWorker.state === 'installed') {
            if (navigator.serviceWorker.controller) {
              // At this point, the updated precached content has been fetched,
              // but the previous service worker will still serve the older
              // content until all client tabs are closed.
              logger.log(
                'New content is available and will be used when all ' +
                  'tabs for this page are closed. See https://bit.ly/CRA-PWA.',
              );

              // Execute callback
              if (config && config.onUpdate) {
                config.onUpdate(registration);
              }
            } else {
              // At this point, everything has been precached.
              // It's the perfect time to display a
              // "Content is cached for offline use." message.
              logger.log('Content is cached for offline use.');

              // Execute callback
              if (config && config.onSuccess) {
                config.onSuccess(registration);
              }
            }
          }
        };
      };
    })
    .catch((error) => {
      logger.error('Error during service worker registration:', error);
    });
}

function checkValidServiceWorker(swUrl: string, config?: Config) {
  // Check if the service worker can be found. If it can't reload the page.
  fetch(swUrl, {
    headers: { 'Service-Worker': 'script' },
  })
    .then((response) => {
      // Ensure service worker exists, and that we really are getting a JS file.
      const contentType = response.headers.get('content-type');
      if (
        response.status === 404 ||
        (contentType != null && contentType.indexOf('javascript') === -1)
      ) {
        // No service worker found. Probably a different app. Reload the page.
        navigator.serviceWorker.ready.then((registration) => {
          registration.unregister().then(() => {
            window.location.reload();
          });
        });
      } else {
        // Service worker found. Proceed as normal.
        registerValidSW(swUrl, config);
      }
    })
    .catch(() => {
      logger.log(
        'No internet connection found. App is running in offline mode.',
      );
    });
}

export function unregister(): void {
  if ('serviceWorker' in navigator) {
    navigator.serviceWorker.ready
      .then((registration) => {
        registration.unregister();
      })
      .catch((error) => {
        logger.error(error.message);
      });
  }
}
helpers/notify
import { ReactNode } from 'react';
import { toast } from 'react-hot-toast';

/**
 * react toastify. invoke alert message at display top right
 * ex)
 * notify({ status: 'success', message: message });
 * @param {String} status One of ['success', 'error']
 * @param {String} message notify message
 */
const notify = ({
  status,
  message,
  renderCustom,
  preventDuplicateId,
}: {
  status: 'success' | 'error' | 'custom';
  message: string;
  renderCustom?: (onClose: () => void) => ReactNode;
  preventDuplicateId?: string;
}): void => {
  switch (status) {
    case 'success':
      toast.success(message, {
        id: preventDuplicateId,
        ariaProps: {
          role: 'status',
          'aria-live': 'polite',
        },
      });
      break;
    case 'error':
      toast.error(message, {
        id: preventDuplicateId,
        ariaProps: {
          role: 'alert',
          'aria-live': 'assertive',
        },
      });
      break;
    case 'custom':
      toast.success(
        (t) => (
          <span>
            {message}
            {renderCustom &&
              renderCustom(() => {
                toast.dismiss(t.id);
              })}
          </span>
        ),
        {
          duration: Infinity,
          id: preventDuplicateId,
        },
      );
      break;
    default:
      throw new Error('Notify Error: Given status is not supported.');
  }
};

export default notify;
このスクラップは2021/12/01にクローズされました