How to return Service Worker with custom HTTP header from custom module

Question

I have a custom module providing a HTML5 Service Worker file under /modules/custom/my_blocks/assets/js/service-worker.js. Since the Service Worker is not located in the root of the Drupal server, I need to return the file with an additional Service-Worker-Allowed HTTP header.

How to do that within my module?

Answer 1

To provide a dynamic file, you need to make a Controller with a method like:

 public function serve(Request $request) {
    $file_str = $file_system->realpath($module_handler->getModule('my_module')->getPath()) . '/assets/js/service-worker.js';

    if (file_exists($file_str)) {

      $response = new BinaryFileResponse($file_str, 200);
      $response->headers->set('Content-Type', 'application/javascript');
      // Allow same origin service worker.
      $response->headers->set('Service-Worker-Allowed', '/');

      return $response;
    }

    throw new NotFoundHttpException();
  }

And then define a route for it, where the path is not existing as a static file, like:

example.serviceworker:
  path: '/serviceworker' 
  defaults: 
    _controller: '\Drupal\my_module\Controller\ExampleController::serve' 
  requirements: 
    _permission: 'access content' 

see - https://www.drupal.org/docs/drupal-apis/routing-system/introductory-drupal-8-routes-and-controllers-example.