Deprecate enableStreaming

.changeset/violet-peaches-notice.md

@@ -0,0 +1,33 @@
+---
+'@shopify/hydrogen': minor
+---
+
+The `enableStreaming` config option has been deprecated. The same feature can be done directly in the app:
+
+```diff
+// hydrogen.config.js
+
+export default defineConfig({
+  shopify: {
+    // ...
+  },
+- enableStreaming: (req) => {
+-   return req.headers.get('user-agent') !== 'custom bot';
+- },
+});
+```
+
+```diff
+// App.server.jsx
+
+-function App() {
++function App({request, response}) {
++ if (request.headers.get('user-agent') === 'custom bot') {
++   response.doNotStream();
++ }
+
+  return <Suspense fallback={'Loading...'}>{/*...*/}</Suspense>;
+}
+
+export default renderHydrogen(App);
+```

docs/framework/hydrogen-config.md

@@ -43,7 +43,6 @@ The following groupings of configuration properties can exist in Hydrogen:
 - [`shopify`](#shopify)
 - [`session`](#session)
 - [`serverAnalyticsConnectors`](#serveranalyticsconnectors)
-- [`enableStreaming`](#enablestreaming)
 - [`logger`](#logger)
 
 ### `routes`
@@ -190,26 +189,6 @@ export default defineConfig({
 
 {% endcodeblock %}
 
-### `enableStreaming`
-
-By default, all routes in Hydrogen are stream rendered. Stream rendering is automatically disabled when the user agent is a bot.
-
-Content should be immediately available to bots for SEO purposes. However, you might want to manually disable streaming for a specific page. A common use case is disabling streaming for a custom bot that's not recognized by Hydrogen's bot detection algorithm. You can disable streaming for a custom bot with the `enableStreaming` configuration property:
-
-{% codeblock file, filename: 'hydrogen.config.ts' %}
-
-```tsx
-import {PerformanceMetricsServerAnalyticsConnector} from '@shopify/hydrogen';
-export default defineConfig({
-  enableStreaming: (req) => req.headers.get('user-agent') !== 'custom bot',
-});
-```
-
-{% endcodeblock %}
-
-> Tip:
-> There are [performance benefits](https://shopify.dev/custom-storefronts/hydrogen/best-practices/performance) to streaming. You shouldn't completely disable streaming for all of your storefront's routes.
-
 ### `logger`
 
 The default behavior of the [`log` utility](https://shopify.dev/api/hydrogen/utilities/log) maps to the global `console` object. However, you can also customize this behavior in the configuration object.

docs/framework/preloaded-queries.md

@@ -103,7 +103,7 @@ const data = fetchSync('https://my.api.com/data.json', {
 
 To test a preloaded query, enable the `logger.showQueryTiming` property in your [Hydrogen configuration file](https://shopify.dev/custom-storefronts/hydrogen/framework/hydrogen-config#logger).
 
-The [`showQueryTiming`](https://shopify.dev/api/hydrogen/utilities/log#logger-options) property logs the timeline of when queries are being requested, resolved, and rendered. If a query is preloaded, but isn't being used, then a warning displays in the server log:
+The [`showQueryTiming`](https://shopify.dev/custom-storefronts/hydrogen/framework/hydrogen-config#logger) property logs the timeline of when queries are being requested, resolved, and rendered. If a query is preloaded, but isn't being used, then a warning displays in the server log:
 
 ![Shows a screenshot of preloaded query warning](/assets/custom-storefronts/hydrogen/preload-query-warning.png)
 

docs/framework/routes.md

@@ -318,7 +318,7 @@ export default function MyProducts({response}) {
 
 #### `response.doNotStream()`
 
-By default, Hydrogen [streams SSR responses](https://shopify.dev/custom-storefronts/hydrogen/framework/streaming-ssr). To customize a response, you need to tell Hydrogen that your server component plans to modify it in some way by calling `response.doNotStream()`:
+By default, Hydrogen [streams SSR responses](https://shopify.dev/custom-storefronts/hydrogen/framework/streaming-ssr). However, you can also disable streaming for each route and return a fully buffered response. This is helpful in scenarios like [handling custom SEO bots](https://shopify.dev/custom-storefronts/hydrogen/framework/seo#checking-for-custom-robots). To disable streaming, call `response.doNotStream()`:
 
 {% codeblock file %}
 
@@ -332,6 +332,9 @@ export default function CustomPage({response}) {
 
 {% endcodeblock %}
 
+> Tip:
+> There are [performance benefits](https://shopify.dev/custom-storefronts/hydrogen/best-practices/performance) to streaming. You shouldn't completely disable streaming for all of your storefront's routes.
+
 You can use `response` to set headers or status codes using the `Response` API:
 
 {% codeblock file %}

docs/framework/seo.md

@@ -148,11 +148,33 @@ return (
 
 {% endcodeblock %}
 
-## Imitating SEO robot behavior
+## SEO robot behavior
 
-Hydrogen supports SEO by inspecting the `user-agent` for every request, and buffering the response to fully render it on server-side.
+By default, all routes in Hydrogen are stream rendered. However, Hydrogen supports SEO by inspecting the `user-agent` for every request, disabling streaming, and buffering the response to fully render it on the server-side.
 
-To imitate the behaviour of a SEO robot and show the page content fully from server render for initial render, add the `?\_bot` query parameter at the end of the webpage's URL.
+### Imitating robot behavior
+
+To imitate the behaviour of a SEO robot and show the page content fully from server render for initial render, add the `?_bot` query parameter at the end of the webpage's URL.
+
+### Checking for custom robots
+
+If you find a bot that's not recognized by Hydrogen's bot detection algorithm, you can [manually disable streaming](https://shopify.dev/custom-storefronts/hydrogen/framework/routes#response-donotstream) to buffer the response and make the content immediately available to bots:
+
+{% codeblock file, filename: 'App.server.jsx' %}
+
+```jsx
+function App({request, response}) {
+  if (request.headers.get('user-agent') === 'custom bot') {
+    response.doNotStream();
+  }
+
+  return <Suspense fallback={'Loading...'}>{/*...*/}</Suspense>;
+}
+
+export default renderHydrogen(App);
+```
+
+{% endcodeblock %}
 
 ## Removing SEO with noindex
 

packages/hydrogen/src/entry-server.tsx

@@ -175,12 +175,9 @@ export const renderHydrogen = (App: any) => {
       });
     }
 
-    const isStreamable =
-      (hydrogenConfig.enableStreaming
-        ? hydrogenConfig.enableStreaming(request)
-        : true) && !isBotUA(url, request.headers.get('user-agent'));
-
-    if (!isStreamable) response.doNotStream();
+    if (isBotUA(url, request.headers.get('user-agent'))) {
+      response.doNotStream();
+    }
 
     return runSSR({
       log,

packages/hydrogen/src/types.ts

@@ -86,7 +86,6 @@ export type InlineHydrogenConfig = {
   serverAnalyticsConnectors?: Array<ServerAnalyticsConnector>;
   logger?: LoggerConfig;
   session?: (log: Logger) => SessionStorageAdapter;
-  enableStreaming?: (request: ServerComponentRequest) => boolean;
 };
 
 export type ResolvedHydrogenConfig = Omit<InlineHydrogenConfig, 'routes'> & {

packages/playground/server-components/hydrogen.config.js

@@ -11,9 +11,6 @@ export default defineConfig({
   session: CookieSessionStorage('__session', {
     expires: new Date(1749343178614),
   }),
-  enableStreaming: (req) => {
-    return req.headers.get('user-agent') !== 'custom bot';
-  },
   logger: {
     trace() {},
     debug() {},

packages/playground/server-components/src/App.server.jsx

@@ -6,7 +6,11 @@ import Custom2 from './customRoutes/custom2.server';
 import LazyRoute from './customRoutes/lazyRoute.server';
 import ServerParams from './customRoutes/params.server';
 
-export default renderHydrogen(() => {
+export default renderHydrogen(({request, response}) => {
+  if (request.headers.get('user-agent') === 'custom bot') {
+    response.doNotStream();
+  }
+
   return (
     <Suspense fallback={'Loading...'}>
       <ShopifyProvider>