fix(seo-inject): add JSON-LD structured data injection

[PierreBrisorgueil]

Summary

• What changed: Added JSON-LD structured data injection to the seo-inject Vite plugin
• Why: The config system supports seo.schema with enabled, type, name, jobTitle, sameAs, etc., but the plugin had no code to read these values or emit a <script type="application/ld+json"> block
• Related issues: Closes fix(seo-inject): add JSON-LD structured data injection #3664

Scope

• Modules impacted: src/lib/plugins/seo-inject.js
• Cross-module impact: none
• Risk level: low

Validation

• npm run lint
• npm run test:unit
• npm run build
• Manual checks done (if applicable)

Guardrails check

• No secrets or credentials introduced (.env*, secrets/**, keys, tokens)
• No risky rename/move of core stack paths
• Changes remain merge-friendly for downstream projects
• Tests added or updated when behavior changed

Notes for reviewers

• Security considerations: JSON-LD values are intentionally NOT HTML-escaped since they live inside a JSON string within a <script> tag, not in HTML attributes. The values come from build-time config (not user input).
• Mergeability considerations: Minimal change — adds a new block after the Twitter Card section with no modifications to existing code.
• Follow-up tasks: None

Summary by CodeRabbit

Release Notes

• New Features

  • Added JSON-LD structured data injection to enhance SEO. When schema is enabled, relevant metadata including type, name, URL, and description are automatically injected into the page head.

• Tests

  • Added comprehensive test suite covering JSON-LD functionality, including validation of required fields and conditional inclusion of optional metadata.

[coderabbitai]

Warning

Rate limit exceeded

@PierreBrisorgueil has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 35f5b5e2-afd0-435c-b92c-3154ff004e66

📥 Commits

Reviewing files that changed from the base of the PR and between 575f31f and 93a5639.

📒 Files selected for processing (2)

• src/lib/plugins/seo-inject.js
• src/lib/plugins/tests/seo-inject.spec.js

📝 Walkthrough

Walkthrough

The seo-inject plugin now generates and injects a <script type="application/ld+json"> tag into the HTML head when seo.schema configuration has enabled set to true and a type is specified. The injected script contains structured data with fields like @context, @type, name, url, and description, plus optional fields like jobTitle, sameAs, and image when available.

Changes

Cohort / File(s)	Summary
JSON-LD Injection Implementation src/lib/plugins/seo-inject.js	Adds JSON-LD structured data generation and injection logic. Builds a jsonLd object when schema.enabled and schema.type are present, conditionally including optional fields (jobTitle, sameAs, image) and pushing a <script type="application/ld+json"> tag to the HTML head.
JSON-LD Test Coverage src/lib/plugins/tests/seo-inject.spec.js	Adds comprehensive test suite validating JSON-LD injection behavior, including tests for field presence/absence, optional field inclusion when configured, and prevention of injection when schema is disabled or type is missing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A rabbit hops through structured light, ✨
JSON-LD now shines oh-so-bright,
Schema data flows with graceful ease,
SEO crawlers surely please! 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding JSON-LD structured data injection to the seo-inject plugin, matching the primary objective of the pull request.
Description check	✅ Passed	The description comprehensively covers all template sections with clear explanations of what changed, why, affected modules, risk level, validation steps, and security considerations.
Linked Issues check	✅ Passed	The pull request successfully implements all requirements from issue #3664: reads seo.schema config, injects JSON-LD when enabled with proper structure including required fields (context, type, name, url, description) and optional fields (jobTitle, sameAs, image) as specified.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with the linked issue requirements: the plugin modification adds JSON-LD support and tests verify the implementation without introducing unrelated changes.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/seo-inject-json-ld

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.16%. Comparing base (0a50388) to head (93a5639).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3670      +/-   ##
==========================================
+ Coverage   91.03%   91.16%   +0.12%     
==========================================
  Files          21       21              
  Lines         636      645       +9     
  Branches      170      176       +6     
==========================================
+ Hits          579      588       +9     
  Misses         57       57              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull request overview

Adds build-time JSON-LD structured data injection to the seo-inject Vite plugin so configured app.seo.schema values can be emitted into the built index.html head (addressing missing functionality described in #3664).

Changes:

• Inject <script type="application/ld+json"> JSON-LD block when seo.schema.enabled and seo.schema.type are set.
• Add unit tests covering JSON-LD injection, omission rules, and optional fields.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/lib/plugins/seo-inject.js	Adds JSON-LD structured data generation/injection into the transformed HTML head.
src/lib/plugins/tests/seo-inject.spec.js	Adds unit tests validating JSON-LD injection behavior and optional fields.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/lib/plugins/seo-inject.js (1)

119-133: Add JSDoc for the modified transformIndexHtml hook.

This change updates the hook, but it still has no JSDoc for html and the returned HTML string.

📝 Suggested fix

   return {
     name: 'seo-inject',
+    /**
+     * Inject SEO tags and structured data into the HTML document.
+     *
+     * `@param` {string} html - Source `index.html` contents.
+     * `@returns` {string} HTML with injected SEO markup.
+     */
     transformIndexHtml(html) {
       const tags = [];

As per coding guidelines, "Every new or modified function must have a JSDoc header with one-line description, @param for each argument, and @returns for any non-void return value (always include @returns for async functions)".

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/lib/plugins/seo-inject.js` around lines 119 - 133, Add a JSDoc header to
the modified transformIndexHtml hook in seo-inject.js: include a one-line
description, an `@param` for the html argument (string) and any other parameters
used (e.g., ctx or opts) with types and brief descriptions, and an `@returns`
describing that the function returns a (possibly Promise-wrapped) HTML string;
ensure the JSDoc notes whether the function is async and documents the returned
string.

src/lib/plugins/tests/seo-inject.spec.js (1)

304-326: Add a regression test for the schema.name fallback.

One of the core requirements from #3664 is that name falls back to app.title when schema.name is absent, but this block only exercises the explicit schema.name path.

✅ Suggested test

   describe('JSON-LD structured data', () => {
     it('injects JSON-LD when schema.enabled is true', () => {
       const config = {
         app: {
           title: 'Test App',
           description: 'Test description',
           url: 'https://example.com',
           seo: {
             schema: { enabled: true, type: 'Person', name: 'Test User' },
           },
         },
       };
       const result = transform(config);
       expect(result).toContain('<script type="application/ld+json">');
       const match = result.match(/<script type="application\/ld\+json">(.*?)<\/script>/);
       expect(match).not.toBeNull();
       const jsonLd = JSON.parse(match[1]);
       expect(jsonLd['@context']).toBe('https://schema.org');
       expect(jsonLd['@type']).toBe('Person');
       expect(jsonLd.name).toBe('Test User');
       expect(jsonLd.url).toBe('https://example.com');
       expect(jsonLd.description).toBe('Test description');
     });
+
+    it('falls back to app.title when schema.name is missing', () => {
+      const config = {
+        app: {
+          title: 'Test App',
+          description: 'Test description',
+          url: 'https://example.com',
+          seo: {
+            schema: { enabled: true, type: 'Person' },
+          },
+        },
+      };
+      const result = transform(config);
+      const match = result.match(/<script type="application\/ld\+json">(.*?)<\/script>/);
+      const jsonLd = JSON.parse(match[1]);
+      expect(jsonLd.name).toBe('Test App');
+    });

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/lib/plugins/tests/seo-inject.spec.js` around lines 304 - 326, Add a
regression test that verifies schema.name falls back to app.title when
schema.name is missing: create a new it-block (next to the existing JSON-LD
test) that builds a config with app.title/app.description/app.url and
seo.schema: { enabled: true, type: 'Person' } but without schema.name, call
transform(config), extract the JSON-LD script the same way as the existing test,
JSON.parse it and assert jsonLd.name === app.title (and keep assertions for
`@context`, `@type`, url and description to ensure all other fields remain correct);
use the same helper/regex and the transform function reference so the test
mirrors the original but verifies the fallback behavior.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/lib/plugins/seo-inject.js`:
- Around line 122-132: The JSON-LD payload built in jsonLd and injected via
tags.push(`  <script
type="application/ld+json">${JSON.stringify(jsonLd)}</script>`) can be
terminated by unescaped values (e.g., schema.name or app.description); change to
a script-safe serialization: produce the JSON string from jsonLd (using
JSON.stringify) then escape any occurrences that would break a script tag (for
example replace the sequence "</script" with "<\/script>" and optionally escape
"<!--" / "-->"), and use that escaped string in the tags.push call (or factor
into a helper like safeJsonStringify/jsonLdToScript to centralize the escaping).

---

Nitpick comments:
In `@src/lib/plugins/seo-inject.js`:
- Around line 119-133: Add a JSDoc header to the modified transformIndexHtml
hook in seo-inject.js: include a one-line description, an `@param` for the html
argument (string) and any other parameters used (e.g., ctx or opts) with types
and brief descriptions, and an `@returns` describing that the function returns a
(possibly Promise-wrapped) HTML string; ensure the JSDoc notes whether the
function is async and documents the returned string.

In `@src/lib/plugins/tests/seo-inject.spec.js`:
- Around line 304-326: Add a regression test that verifies schema.name falls
back to app.title when schema.name is missing: create a new it-block (next to
the existing JSON-LD test) that builds a config with
app.title/app.description/app.url and seo.schema: { enabled: true, type:
'Person' } but without schema.name, call transform(config), extract the JSON-LD
script the same way as the existing test, JSON.parse it and assert jsonLd.name
=== app.title (and keep assertions for `@context`, `@type`, url and description to
ensure all other fields remain correct); use the same helper/regex and the
transform function reference so the test mirrors the original but verifies the
fallback behavior.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3586985d-9e79-4d6e-869d-5cc28af12735

📥 Commits

Reviewing files that changed from the base of the PR and between 0a50388 and 575f31f.

📒 Files selected for processing (2)

• src/lib/plugins/seo-inject.js
• src/lib/plugins/tests/seo-inject.spec.js