changed userContext and userCtx to envData

Author: shairez

packages/qwik-city/buildtime/vite/dev-server.ts

@@ -7,7 +7,7 @@ import type { BuildContext } from '../types';
 import type { EndpointModule } from '../../runtime/src/library/types';
 import type { QwikViteDevResponse } from '../../../qwik/src/optimizer/src/plugins/vite';
 import { loadUserResponse } from '../../middleware/request-handler/user-response';
-import { getQwikCityUserContext } from '../../middleware/request-handler/utils';
+import { getQwikCityEnvData } from '../../middleware/request-handler/utils';
 import { buildFromUrlPathname } from '../build';
 import { notFoundHandler } from '../../middleware/request-handler/fallback-handler';
 import type { QwikCityRequestContext } from '../../middleware/request-handler/types';
@@ -77,17 +77,17 @@ export function configureDevServer(ctx: BuildContext, server: ViteDevServer) {
         if (userResponse.type === 'page') {
           // qwik city vite plugin should handle dev ssr rendering
           // but add the qwik city user context to the response object
-          const userContext = getQwikCityUserContext(userResponse);
+          const envData = getQwikCityEnvData(userResponse);
           if (ctx.isDevServerClientOnly) {
             // because we stringify this content for the client only
             // dev server, there's some potential stringify issues
             // client only dev server will re-fetch anyways, so reset
-            userContext.qwikcity.response.body = undefined;
+            envData.qwikcity.response.body = undefined;
           }
 
-          (res as QwikViteDevResponse)._qwikUserCtx = {
-            ...(res as QwikViteDevResponse)._qwikUserCtx,
-            ...userContext,
+          (res as QwikViteDevResponse)._qwikEnvData = {
+            ...(res as QwikViteDevResponse)._qwikEnvData,
+            ...envData,
           };
 
           // update node response with status and headers

packages/qwik-city/middleware/request-handler/request-handler.ts

@@ -3,7 +3,7 @@ import { loadUserResponse } from './user-response';
 import type { QwikCityRequestContext, QwikCityRequestOptions } from './types';
 import { ROUTE_TYPE_ENDPOINT } from '../../runtime/src/library/constants';
 import type { Render, RenderToStringResult } from '@builder.io/qwik/server';
-import { getQwikCityUserContext } from './utils';
+import { getQwikCityEnvData } from './utils';
 import { errorHandler } from './fallback-handler';
 import cityPlan from '@qwik-city-plan';
 
@@ -53,7 +53,7 @@ export async function requestHandler<T = any>(
         const result = await render({
           stream,
           url: url.href,
-          userContext: getQwikCityUserContext(userResponse),
+          envData: getQwikCityEnvData(userResponse),
           ...opts,
         });
         if ((typeof result as any as RenderToStringResult).html === 'string') {

packages/qwik-city/middleware/request-handler/utils.ts

@@ -1,8 +1,8 @@
-import type { QwikCityUserContext } from '../../runtime/src/library/types';
+import type { QwikCityEnvData } from '../../runtime/src/library/types';
 import type { UserResponseContext } from './types';
 
-export function getQwikCityUserContext(userResponseContext: UserResponseContext): {
-  qwikcity: QwikCityUserContext;
+export function getQwikCityEnvData(userResponseContext: UserResponseContext): {
+  qwikcity: QwikCityEnvData;
 } {
   return {
     qwikcity: {

packages/qwik-city/runtime/src/library/types.ts

@@ -284,7 +284,7 @@ export interface EndpointResponse {
 
 export interface QwikCityRenderDocument extends Document {}
 
-export interface QwikCityUserContext {
+export interface QwikCityEnvData {
   route: MutableRouteLocation;
   response: EndpointResponse;
 }

packages/qwik-city/runtime/src/library/use-functions.ts

@@ -5,12 +5,7 @@ import {
   RouteLocationContext,
   RouteNavigateContext,
 } from './contexts';
-import type {
-  RouteLocation,
-  ResolvedDocumentHead,
-  RouteNavigate,
-  QwikCityUserContext,
-} from './types';
+import type { RouteLocation, ResolvedDocumentHead, RouteNavigate, QwikCityEnvData } from './types';
 
 /**
  * @public
@@ -34,5 +29,5 @@ export const useLocation = (): RouteLocation => useContext(RouteLocationContext)
 export const useNavigate = (): RouteNavigate => useContext(RouteNavigateContext);
 
 export const useQwikCityContext = () => {
-  return noSerialize(useEnvData<QwikCityUserContext>('qwikcity'));
+  return noSerialize(useEnvData<QwikCityEnvData>('qwikcity'));
 };

packages/qwik/src/core/api.md

@@ -397,7 +397,7 @@ export interface RenderOptions {
     // (undocumented)
     allowRerender?: boolean;
     // (undocumented)
-    userContext?: Record<string, any>;
+    envData?: Record<string, any>;
 }
 
 // Warning: (ae-forgotten-export) The symbol "RenderSSROptions" needs to be exported by the entry point index.d.ts

packages/qwik/src/core/render/container.ts

@@ -42,7 +42,7 @@ export interface ContainerState {
   $hostsRendering$: Set<Element> | undefined;
   $renderPromise$: Promise<RenderContext> | undefined;
 
-  $userContext$: Record<string, any>;
+  $envData$: Record<string, any>;
   $elementIndex$: number;
 
   $stylesIds$: Set<string>;
@@ -68,7 +68,7 @@ export const getContainerState = (containerEl: Element): ContainerState => {
       $renderPromise$: undefined,
       $hostsRendering$: undefined,
 
-      $userContext$: {},
+      $envData$: {},
       $elementIndex$: 0,
 
       $stylesIds$: new Set(),

packages/qwik/src/core/render/dom/render.public.ts

@@ -21,7 +21,7 @@ import { BASE_QWIK_STYLES, createRenderContext } from '../execute-component';
  */
 export interface RenderOptions {
   allowRerender?: boolean;
-  userContext?: Record<string, any>;
+  envData?: Record<string, any>;
 }
 
 /**
@@ -53,9 +53,9 @@ export const render = async (
   injectQContainer(containerEl);
 
   const containerState = getContainerState(containerEl);
-  const userContext = opts?.userContext;
-  if (userContext) {
-    Object.assign(containerState.$userContext$, userContext);
+  const envData = opts?.envData;
+  if (envData) {
+    Object.assign(containerState.$envData$, envData);
   }
   containerState.$hostsRendering$ = new Set();
   containerState.$renderPromise$ = renderRoot(parent, jsxNode, doc, containerState, containerEl);

packages/qwik/src/core/render/ssr/render-ssr.ts

@@ -51,7 +51,7 @@ export interface RenderSSROptions {
   fragmentTagName?: string;
   stream: StreamWriter;
   base?: string;
-  userContext?: Record<string, any>;
+  envData?: Record<string, any>;
   url?: string;
   beforeContent?: JSXNode[];
   beforeClose?: (contexts: QContext[], containerState: ContainerState) => Promise<JSXNode>;
@@ -87,10 +87,10 @@ export const renderSSR = async (doc: Document, node: JSXNode, opts: RenderSSROpt
     containerAttributes['q:base'] = opts.base;
   }
   if (opts.url) {
-    containerState.$userContext$['url'] = opts.url;
+    containerState.$envData$['url'] = opts.url;
   }
-  if (opts.userContext) {
-    Object.assign(containerState.$userContext$, opts.userContext);
+  if (opts.envData) {
+    Object.assign(containerState.$envData$, opts.envData);
   }
 
   if (opts.fragmentTagName) {

packages/qwik/src/core/use/use-env-data.ts

@@ -15,5 +15,5 @@ export function useEnvData<T, B = T>(key: string, defaultValue: B): T | B;
  */
 export function useEnvData(key: string, defaultValue?: any) {
   const ctx = useInvokeContext();
-  return ctx.$renderCtx$.$containerState$.$userContext$[key] ?? defaultValue;
+  return ctx.$renderCtx$.$containerState$.$envData$[key] ?? defaultValue;
 }