[Bug]: the parameter outline in page.pdf seems not work

[zsq471214943]

Minimal, reproducible example

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch({
    executablePath:"D:\\tools\\.local-browser\\win64-1293398\\chrome-win\\chrome.exe",
    args:["--no-sandbox","--disable-setuid-sandbox","--generate-pdf-document-outline"],
    protocol:"cdp"
  });
  const page = await browser.newPage();
  await page.goto('file://D:\\temp\\filetest\\html\\测试pdf.html', {
    waitUntil: 'networkidle2',
  });
  // page.pdf() is currently supported only in headless mode.
  // @see https://bugs.chromium.org/p/chromium/issues/detail?id=753118
   await page.pdf({
    path: 'hn.pdf',
    format: 'letter',
    outline: true,
    timeout: 0
  });

  await browser.close();
})();

Error string

no error

Bug behavior

• Flaky
• PDF

Background

Expectation

the export pdf include the toc

Reality

The result did not output as expected

Puppeteer configuration file (if used)

No response

Puppeteer version

22.7.1

Node version

20.12.2

Package manager

npm

Package manager version

10.5.0

Operating system

Windows

[github-actions]

This issue was not reproducible. Please check that your example runs locally and the following:

• Ensure the script does not rely on dependencies outside of puppeteer and puppeteer-core.
• Ensure the error string is just the error message.

  • Bad:

    Error: something went wrong
      at Object.<anonymous> (/Users/username/repository/script.js:2:1)
      at Module._compile (node:internal/modules/cjs/loader:1159:14)
      at Module._extensions..js (node:internal/modules/cjs/loader:1213:10)
      at Module.load (node:internal/modules/cjs/loader:1037:32)
      at Module._load (node:internal/modules/cjs/loader:878:12)
      at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
      at node:internal/main/run_main_module:23:47

  • Good: Error: something went wrong.

• Ensure your configuration file (if applicable) is valid.
• If the issue is flaky (does not reproduce all the time), make sure 'Flaky' is checked.
• If the issue is not expected to error, make sure to write 'no error'.

Once the above checks are satisfied, please edit your issue with the changes and we will
try to reproduce the bug again.

---

Analyzer run

[OrKoN]

outline parameter only works for the old headless mode (headless: 'shell') Currently Chrome does not support it.

[OrKoN]

@Lightning00Blade could you please update the documentation to make sure the outline option remark properly show up on the website? Perhaps it makes sense to throw an error if it is used in the incompatible mode.

[OrKoN]

@Lightning00Blade let's also file a feature request to have this feature for Chrome and not only for the headless shell.

[Lightning00Blade]

There is already a bug on Chromium to add support for this option: https://issues.chromium.org/issues/41387522#comment48
Please upvote that feature request as it signals interest in the feature.

[OrKoN]

Looks like the feature is already implemented upstream and will likely ship with Chrome M126.