refactor: rename useUserContext to useEnvData (#901)

shairez · adamdbradley · web-flow · commit 13a81d3eaf19 · 2022-08-03T12:22:27.000-05:00
Co-authored-by: Adam Bradley &lt;adamdbradley@users.noreply.github.com&gt;
diff --git a/packages/qwik-city/buildtime/vite/dev-server.ts b/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/page-handler';
+import { getQwikCityEnvData } from '../../middleware/request-handler/page-handler';
 import { buildFromUrlPathname } from '../build';
 import { endpointHandler } from '../../middleware/request-handler/endpoint-handler';
 import { notFoundHandler } from '../../middleware/request-handler/error-handler';
@@ -71,17 +71,23 @@ export function configureDevServer(ctx: BuildContext, server: ViteDevServer) {
 
         // 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,
+        // TODO: removed after @deprecation period
+        (res as any)._qwikUserCtx = {
+          ...(res as any)._qwikUserCtx,
+          ...envData,
+        };
+
+        (res as QwikViteDevResponse)._qwikEnvData = {
+          ...(res as QwikViteDevResponse)._qwikEnvData,
+          ...envData,
         };
 
         // update node response with status and headers
diff --git a/packages/qwik-city/middleware/request-handler/page-handler.ts b/packages/qwik-city/middleware/request-handler/page-handler.ts
@@ -1,5 +1,5 @@
 import type { Render, RenderToStringResult } from '@builder.io/qwik/server';
-import type { QwikCityUserContext } from '../../runtime/src/library/types';
+import type { QwikCityEnvData } from '../../runtime/src/library/types';
 import type { QwikCityRequestContext, QwikCityRequestOptions, UserResponseContext } from './types';
 
 export function pageHandler<T = any>(
@@ -20,7 +20,7 @@ export function pageHandler<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') {
@@ -29,10 +29,10 @@ export function pageHandler<T = any>(
   });
 }
 
-export function getQwikCityUserContext(userResponseContext: UserResponseContext): {
-  qwikcity: QwikCityUserContext;
+export function getQwikCityEnvData(userResponse: UserResponseContext): {
+  qwikcity: QwikCityEnvData;
 } {
-  const { url, params, pendingBody, resolvedBody, status } = userResponseContext;
+  const { url, params, pendingBody, resolvedBody, status } = userResponse;
   return {
     qwikcity: {
       route: {
diff --git a/packages/qwik-city/runtime/src/library/types.ts b/packages/qwik-city/runtime/src/library/types.ts
@@ -290,7 +290,7 @@ export interface EndpointResponse {
 
 export interface QwikCityRenderDocument extends Document {}
 
-export interface QwikCityUserContext {
+export interface QwikCityEnvData {
   route: MutableRouteLocation;
   response: EndpointResponse;
 }
diff --git a/packages/qwik-city/runtime/src/library/use-functions.ts b/packages/qwik-city/runtime/src/library/use-functions.ts
@@ -1,16 +1,11 @@
-import { noSerialize, useContext, useUserContext } from '@builder.io/qwik';
+import { noSerialize, useContext, useEnvData } from '@builder.io/qwik';
 import {
   ContentContext,
   DocumentHeadContext,
   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(useUserContext<QwikCityUserContext>('qwikcity'));
+  return noSerialize(useEnvData<QwikCityEnvData>('qwikcity'));
 };
diff --git a/packages/qwik/src/core/api.md b/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
@@ -572,6 +572,12 @@ export interface UseEffectOptions {
     eagerness?: EagernessOptions;
 }
 
+// @alpha (undocumented)
+export function useEnvData<T>(key: string): T | undefined;
+
+// @alpha (undocumented)
+export function useEnvData<T, B = T>(key: string, defaultValue: B): T | B;
+
 // @public
 export const useHostElement: () => Element;
 
@@ -639,11 +645,8 @@ export const useStylesScoped$: (first: string) => void;
 // @alpha (undocumented)
 export const useStylesScopedQrl: (styles: QRL<string>) => void;
 
-// @alpha (undocumented)
-export function useUserContext<T>(key: string): T | undefined;
-
-// @alpha (undocumented)
-export function useUserContext<T, B = T>(key: string, defaultValue: B): T | B;
+// @alpha @deprecated (undocumented)
+export const useUserContext: typeof useEnvData;
 
 // Warning: (ae-forgotten-export) The symbol "UseWatchOptions" needs to be exported by the entry point index.d.ts
 // Warning: (ae-incompatible-release-tags) The symbol "useWatch$" is marked as @public, but its signature references "WatchFn" which is marked as @alpha
diff --git a/packages/qwik/src/core/index.ts b/packages/qwik/src/core/index.ts
@@ -81,7 +81,7 @@ export { useDocument } from './use/use-document.public';
 export { useLexicalScope } from './use/use-lexical-scope.public';
 export { useStore, useRef } from './use/use-store.public';
 export { useContext, useContextProvider, createContext } from './use/use-context';
-export { useUserContext } from './use/use-user-context';
+export { useEnvData, useUserContext } from './use/use-env-data';
 export { useStylesQrl, useStyles$, useStylesScopedQrl, useStylesScoped$ } from './use/use-styles';
 export { useOn, useOnDocument, useOnWindow, useCleanupQrl, useCleanup$ } from './use/use-on';
 export type { Context } from './use/use-context';
diff --git a/packages/qwik/src/core/render/container.ts b/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;
 
   $styleIds$: Set<string>;
@@ -68,7 +68,7 @@ export const getContainerState = (containerEl: Element): ContainerState => {
       $renderPromise$: undefined,
       $hostsRendering$: undefined,
 
-      $userContext$: {},
+      $envData$: {},
       $elementIndex$: 0,
 
       $styleIds$: new Set(),
diff --git a/packages/qwik/src/core/render/dom/render.public.ts b/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);
diff --git a/packages/qwik/src/core/render/ssr/render-ssr.ts b/packages/qwik/src/core/render/ssr/render-ssr.ts
@@ -56,7 +56,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>;
@@ -93,10 +93,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) {
diff --git a/packages/qwik/src/core/use/use-env-data.ts b/packages/qwik/src/core/use/use-env-data.ts
@@ -0,0 +1,25 @@
+import { useInvokeContext } from './use-core';
+
+/**
+ * @alpha
+ */
+export function useEnvData<T>(key: string): T | undefined;
+
+/**
+ * @alpha
+ */
+export function useEnvData<T, B = T>(key: string, defaultValue: B): T | B;
+
+/**
+ * @alpha
+ */
+export function useEnvData(key: string, defaultValue?: any) {
+  const ctx = useInvokeContext();
+  return ctx.$renderCtx$.$containerState$.$envData$[key] ?? defaultValue;
+}
+
+/**
+ * @alpha
+ * @deprecated Please use `useEnvData` instead.
+ */
+export const useUserContext = useEnvData;
diff --git a/packages/qwik/src/core/use/use-user-context.ts b/packages/qwik/src/core/use/use-user-context.ts
diff --git a/packages/qwik/src/optimizer/src/plugins/vite.ts b/packages/qwik/src/optimizer/src/plugins/vite.ts
@@ -429,8 +429,8 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {
 
         try {
           if (req.headers.accept && req.headers.accept.includes('text/html')) {
-            const userContext: Record<string, any> = {
-              ...(res as QwikViteDevResponse)._qwikUserCtx,
+            const envData: Record<string, any> = {
+              ...(res as QwikViteDevResponse)._qwikEnvData,
               url: url.href,
             };
 
@@ -441,7 +441,7 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {
               const relPath = path.relative(opts.rootDir, clientDevInput!);
               const entryUrl = '/' + qwikPlugin.normalizePath(relPath);
 
-              let html = getViteDevIndexHtml(entryUrl, userContext);
+              let html = getViteDevIndexHtml(entryUrl, envData);
               html = await server.transformIndexHtml(pathname, html);
 
               res.setHeader('Content-Type', 'text/html; charset=utf-8');
@@ -513,7 +513,7 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {
                       }
                     },
                 prefetchStrategy: null,
-                userContext,
+                envData: envData,
               };
 
               res.setHeader('Content-Type', 'text/html; charset=utf-8');
@@ -559,7 +559,7 @@ export function qwikVite(qwikViteOpts: QwikVitePluginOptions = {}): any {
   return vitePlugin;
 }
 
-function getViteDevIndexHtml(entryUrl: string, userContext: Record<string, any>) {
+function getViteDevIndexHtml(entryUrl: string, envData: Record<string, any>) {
   return `<!DOCTYPE html>
 <html>
   <head>
@@ -569,9 +569,9 @@ function getViteDevIndexHtml(entryUrl: string, userContext: Record<string, any>)
     async function main() {
       const mod = await import("${entryUrl}?${VITE_DEV_CLIENT_QS}=");
       if (mod.default) {
-        const userContext = JSON.parse(${JSON.stringify(JSON.stringify(userContext))})
+        const envData = JSON.parse(${JSON.stringify(JSON.stringify(envData))})
         mod.default({
-          userContext,
+          envData,
         });
       }
     }
@@ -759,5 +759,5 @@ export interface QwikVitePluginOptions {
 }
 
 export interface QwikViteDevResponse {
-  _qwikUserCtx?: Record<string, any>;
+  _qwikEnvData?: Record<string, any>;
 }
diff --git a/packages/qwik/src/server/api.md b/packages/qwik/src/server/api.md
@@ -134,15 +134,15 @@ export type Render = RenderToString | RenderToStream;
 // @public (undocumented)
 export interface RenderOptions extends SerializeDocumentOptions {
     base?: string;
+    // (undocumented)
+    envData?: Record<string, any>;
     fragmentTagName?: string;
     // Warning: (ae-incompatible-release-tags) The symbol "prefetchStrategy" is marked as @public, but its signature references "PrefetchStrategy" which is marked as @alpha
     //
     // (undocumented)
     prefetchStrategy?: PrefetchStrategy | null;
     qwikLoader?: QwikLoaderOptions;
     snapshot?: boolean;
-    // (undocumented)
-    userContext?: Record<string, any>;
 }
 
 // @public (undocumented)
diff --git a/packages/qwik/src/server/render.ts b/packages/qwik/src/server/render.ts
@@ -107,7 +107,7 @@ export async function renderToStream(
   await renderSSR(doc, rootNode, {
     stream,
     fragmentTagName: opts.fragmentTagName,
-    userContext: opts.userContext,
+    envData: opts.envData,
     url: opts.url instanceof URL ? opts.url.href : opts.url,
     base: buildBase,
     beforeContent,
diff --git a/packages/qwik/src/server/types.ts b/packages/qwik/src/server/types.ts
@@ -123,7 +123,7 @@ export interface RenderOptions extends SerializeDocumentOptions {
    */
   fragmentTagName?: string;
 
-  userContext?: Record<string, any>;
+  envData?: Record<string, any>;
 }
 
 /**
@@ -175,6 +175,6 @@ export type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToSt
  */
 export type Render = RenderToString | RenderToStream;
 
-export interface RenderDocumentUserContext {
-  _qwikUserCtx?: Record<string, any>;
+export interface RenderDocumentEnvData {
+  _qwikEnvData?: Record<string, any>;
 }
diff --git a/packages/qwik/src/testing/api.md b/packages/qwik/src/testing/api.md
@@ -134,15 +134,15 @@ export type Render = RenderToString | RenderToStream;
 // @public (undocumented)
 export interface RenderOptions extends SerializeDocumentOptions {
     base?: string;
+    // (undocumented)
+    envData?: Record<string, any>;
     fragmentTagName?: string;
     // Warning: (ae-incompatible-release-tags) The symbol "prefetchStrategy" is marked as @public, but its signature references "PrefetchStrategy" which is marked as @alpha
     //
     // (undocumented)
     prefetchStrategy?: PrefetchStrategy | null;
     qwikLoader?: QwikLoaderOptions;
     snapshot?: boolean;
-    // (undocumented)
-    userContext?: Record<string, any>;
 }
 
 // @public (undocumented)

Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ export interface EndpointResponse {`
`290`	`290`
`291`	`291`	`export interface QwikCityRenderDocument extends Document {}`
`292`	`292`
`293`		`-export interface QwikCityUserContext {`
	`293`	`+export interface QwikCityEnvData {`
`294`	`294`	`route: MutableRouteLocation;`
`295`	`295`	`response: EndpointResponse;`
`296`	`296`	`}`