getGuidesMarkdownInternal() — supabase Function Reference

Source Code

apps/docs/features/docs/GuidesMdx.utils.tsx lines 46–105

const getGuidesMarkdownInternal = async (slug: string[]) => {
  const relPath = slug.join(sep).replace(/\/$/, '')
  const fullPath = join(GUIDES_DIRECTORY, relPath + '.mdx')
  const guidesPath = `/guides/${slug.join('/')}`

  /**
   * SAFETY CHECK:
   * Prevent accessing anything outside of published sections and GUIDES_DIRECTORY
   */
  if (
    !fullPath.startsWith(GUIDES_DIRECTORY) ||
    !PUBLISHED_SECTIONS.some((section) => relPath.startsWith(section))
  ) {
    notFound()
  }

  /**
   * DISABLED PAGE CHECK:
   * Check if this page is disabled in the navigation configuration
   */
  if (!checkGuidePageEnabled(guidesPath)) {
    console.log('Page is disabled: %s', guidesPath)
    notFound()
  }

  try {
    const guide = (await GuideModelLoader.fromFs(relative(GUIDES_DIRECTORY, fullPath))).unwrap()
    const content = guide.content ?? ''
    const meta = guide.metadata ?? {}

    if (!isValidGuideFrontmatter(meta)) {
      throw Error(`Type of frontmatter is not valid for path: ${fullPath}`)
    }

    const editLink = newEditLink(
      `supabase/supabase/blob/master/apps/docs/content/guides/${relPath}.mdx`
    )

    return {
      pathname: `/guides/${slug.join('/')}` satisfies `/${string}`,
      meta,
      content,
      editLink,
    }
  } catch (error: unknown) {
    if (error instanceof Error && error.cause instanceof FileNotFoundError) {
      // Not using console.error because this includes pages that are genuine
      // 404s and clutters up the logs
      console.log('Could not read Markdown at path: %s', fullPath)
    } else {
      console.error(
        'Error processing Markdown file at path: %s:\n\t%s',
        fullPath,
        extractMessageFromAnyError(error)
      )
      Sentry.captureException(error)
    }
    notFound()
  }
}