Open1ヶ月前にコメント追加2

コンテナ下のNextJSで環境変数がうまく参照できていなかった話

api/route.tsでGOOGLE_MAP_API_KEYを使って緯度経度を取得しており、ローカル環境では.env.localから参照して普通に動作していた

コンテナ上で実行するとGOOGLE_MAP_API_KEYがundefinedとなってエラーを吐いた。

		const response = await client.geocode({
			params: {
				address: address,
				key: process.env.GOOGLE_MAP_API_KEY as string,
			},
		});

この環境変数はdockerのビルド時にargsで渡していた

docker build \
  -t app \
--build-arg GOOGLE_MAP_API_KEY=apy-key \
  .

他にも--build-argでNEXT_PUBLIC_のprefixがついた環境変数を渡していたが、それはapp側で参照できていた

api/route.tsで参照している環境変数なので、このprefixは要らないはずだが参照できていないどうして？

サイトウ

NEXT_PUBLIC_のprefixがついた環境変数はビルド時にJavaScript のバンドルにインラインされるのでビルド時に指定するが、通常の環境変数については起動するコンテナ上の環境変数として設定されていないと動かないという話だった、今回マルチステージでビルドをしていたのでビルド時に必要な変数と実行環境で必要な変数は分けて考える必要がありました。

仕様をよく読みましょう。。。

FROM node:20-alpine AS base

# Install dependencies only when needed
FROM base AS deps
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
RUN apk add --no-cache libc6-compat
WORKDIR /app

# Install dependencies based on the preferred package manager
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
RUN \
  if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
  elif [ -f package-lock.json ]; then npm ci; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm i --frozen-lockfile; \
  else echo "Lockfile not found." && exit 1; \
  fi


# Rebuild the source code only when needed
FROM base AS builder
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .

# 環境変数を受け取る
ARG NEXT_PUBLIC_SITE_URL
ARG NEXT_PUBLIC_ORDER_MATCHING_API_URL
# 環境変数を設定
ENV NEXT_PUBLIC_SITE_URL=$NEXT_PUBLIC_SITE_URL
ENV NEXT_PUBLIC_API_URL=$NEXT_PUBLIC_API_URL
# Next.js collects completely anonymous telemetry data about general usage.
# Learn more here: https://nextjs.org/telemetry
# Uncomment the following line in case you want to disable telemetry during the build.
# ENV NEXT_TELEMETRY_DISABLED=1

RUN \
  if [ -f yarn.lock ]; then yarn run build; \
  elif [ -f package-lock.json ]; then npm run build; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm run build; \
  else echo "Lockfile not found." && exit 1; \
  fi

# Production image, copy all the files and run next
FROM base AS runner
WORKDIR /app

ENV NODE_ENV=production
# Uncomment the following line in case you want to disable telemetry during runtime.
# ENV NEXT_TELEMETRY_DISABLED=1

# クライアントサイドに公開しない環境変数はrunnerで指定する必要があった
ARG GOOGLE_MAP_API_KEY
ENV GOOGLE_MAP_API_KEY=$GOOGLE_MAP_API_KEY

RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs

COPY --from=builder /app/public ./public

# Set the correct permission for prerender cache
RUN mkdir .next
RUN chown nextjs:nodejs .next

# Automatically leverage output traces to reduce image size
# https://nextjs.org/docs/advanced-features/output-file-tracing
COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static

USER nextjs

EXPOSE 3000

ENV PORT=3000

# server.js is created by next build from the standalone output
# https://nextjs.org/docs/pages/api-reference/next-config-js/output
ENV HOSTNAME="0.0.0.0"
CMD ["node", "server.js"]