chore: move devSsrServer option to qwikRouter()

Author: wmertens

packages/qwik-router/src/buildtime/vite/plugin.ts

@@ -51,6 +51,8 @@ function qwikRouterPlugin(userOpts?: QwikRouterVitePluginOptions): any {
   let viteCommand: string;
   let devServer: ViteDevServer | null = null;
 
+  let devSsrServer = userOpts?.devSsrServer;
+
   const api: QwikRouterPluginApi = {
     getBasePathname: () => ctx?.opts.basePathname ?? '/',
     getRoutes: () => {
@@ -136,6 +138,10 @@ function qwikRouterPlugin(userOpts?: QwikRouterVitePluginOptions): any {
       if (!qwikPlugin) {
         throw new Error('Missing vite-plugin-qwik');
       }
+      if (typeof devSsrServer !== 'boolean') {
+        // read the old option from qwik plugin
+        devSsrServer = qwikPlugin.api._oldDevSsrServer();
+      }
       qwikPlugin.api.registerBundleGraphAdder?.((manifest) => {
         return getRouteImports(ctx!.routes, manifest);
       });
@@ -172,10 +178,12 @@ function qwikRouterPlugin(userOpts?: QwikRouterVitePluginOptions): any {
         }
       });
 
-      // this callback runs after all other middlewares have been added, so we can SSR as the last middleware
-      return () => {
-        server.middlewares.use(makeRouterDevMiddleware(server, ctx!));
-      };
+      if (userOpts?.devSsrServer !== false) {
+        // this callback runs after all other middlewares have been added, so we can SSR as the last middleware
+        return () => {
+          server.middlewares.use(makeRouterDevMiddleware(server, ctx!));
+        };
+      }
     },
 
     transformIndexHtml() {

packages/qwik-router/src/buildtime/vite/qwik-router.buildtime.api.md

@@ -44,6 +44,7 @@ export interface QwikRouterPlugin extends P<QwikRouterPluginApi> {
 //
 // @public (undocumented)
 export interface QwikRouterVitePluginOptions extends Omit<PluginOptions, 'basePathname'> {
+    devSsrServer?: boolean;
     // Warning: (ae-forgotten-export) The symbol "ImageOptimizationOptions" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)

packages/qwik-router/src/buildtime/vite/types.ts

@@ -34,6 +34,17 @@ export interface QwikRouterVitePluginOptions extends Omit<PluginOptions, 'basePa
   imageOptimization?: ImageOptimizationOptions;
   /** Whether to use static imports for route modules (layout and index files). Defaults to `false`. */
   staticImportRoutes?: boolean;
+  /**
+   * Qwik is an SSR first framework. This means that Qwik requires either SSR or SSG. In Vite dev
+   * mode the dev SSR server is responsible for rendering and pausing the application on the
+   * server.
+   *
+   * Under normal circumstances this should be on, unless you have your own dev SSR server setup and
+   * wish to disable this one.
+   *
+   * Default: true
+   */
+  devSsrServer?: boolean;
 }
 
 /** @public */

packages/qwik/src/optimizer/src/plugins/vite.ts

@@ -76,6 +76,7 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {
     getClientPublicOutDir: () => clientPublicOutDir,
     getAssetsDir: () => viteAssetsDir,
     registerBundleGraphAdder: (adder: BundleGraphAdder) => bundleGraphAdders.add(adder),
+    _oldDevSsrServer: () => qwikViteOpts.devSsrServer,
   };
 
   // We provide two plugins to Vite. The first plugin is the main plugin that handles all the
@@ -825,15 +826,7 @@ interface QwikVitePluginSSROptions extends QwikVitePluginCommonOptions {
     manifestOutput?: (manifest: QwikManifest) => Promise<void> | void;
   };
 
-  /**
-   * Qwik is SSR first framework. This means that Qwik requires either SSR or SSG. In dev mode the
-   * dev SSR server is responsible for rendering and pausing the application on the server.
-   *
-   * Under normal circumstances this should be on, unless you have your own SSR server which you
-   * would like to use instead and wish to disable this one.
-   *
-   * Default: true
-   */
+  /** @deprecated Use the `devSsrServer` option of the qwikRouter() plugin instead. */
   devSsrServer?: boolean;
 
   /** Controls the SSR behavior. */
@@ -882,6 +875,8 @@ export interface QwikVitePluginApi {
   getClientPublicOutDir: () => string | null;
   getAssetsDir: () => string | undefined;
   registerBundleGraphAdder: (adder: BundleGraphAdder) => void;
+  /** @internal */
+  _oldDevSsrServer: () => boolean | undefined;
 }
 
 /**

packages/qwik/src/optimizer/src/qwik.optimizer.api.md

@@ -293,6 +293,8 @@ export interface QwikVitePluginApi {
     getOptions: () => NormalizedQwikPluginOptions;
     // (undocumented)
     getRootDir: () => string | null;
+    // @internal (undocumented)
+    _oldDevSsrServer: () => boolean | undefined;
     // (undocumented)
     registerBundleGraphAdder: (adder: BundleGraphAdder) => void;
 }