Class ChromiumFunctionPostRoute

src/shared/function.http.ts:43–96

export type ResponseSchema = unknown;

export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
  name = BrowserlessRoutes.ChromiumFunctionPostRoute;
  accepts = [contentTypes.json, contentTypes.javascript];
  auth = true;
  browser = ChromiumCDP;
  concurrency = true;
  contentTypes = [contentTypes.any];
  description = dedent(`
  A JSON or JavaScript content-type API for running puppeteer code in the browser's context.
  Browserless sets up a blank page, injects your puppeteer code, and runs it.
  You can optionally load external libraries via the "import" module that are meant for browser usage.
  Values returned from the function are checked and an appropriate content-type and response is sent back
  to your HTTP call.`);
  method = Methods.post;
  path = [HTTPRoutes.chromiumFunction, HTTPRoutes.function];
  tags = [APITags.browserAPI];
  async handler(
    req: Request,
    res: ServerResponse,
    logger: Logger,
    browser: BrowserInstance,
  ): Promise<void> {
    const config = this.config();
    const timeout = req.parsed.searchParams.get('timeout');
    const handler = functionHandler(config, logger, {
      protocolTimeout: timeout ? +timeout : undefined,
    });
    const { contentType, payload, page } = await handler(req, browser);

    logger.debug(`Got function response of "${contentType}"`);
    page.removeAllListeners();
    page.close().catch(() => {});

    if (contentType === 'uint8array') {
      const response = new Uint8Array(payload as Buffer);
      const type = ((await fileTypeFromBuffer(response)) || { mime: undefined })
        .mime;

      if (!type) {
        throw new BadRequest(`Couldn't determine function's response type.`);
      } else {
        logger.debug(`Sending file-type response of "${type}"`);
        const readStream = new Stream.PassThrough();
        readStream.end(response);
        res.setHeader('Content-Type', type);
        return new Promise((r) => readStream.pipe(res).once('close', r));
      }
    } else {
      writeResponse(res, 200, payload as string, contentType as contentTypes);
    }

    return;
  }
}