Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prefix for exported functions #1205

Merged
merged 1 commit into from
Feb 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/11_fs-router/src/entries.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { fsRouter } from 'waku/router/server';
import { unstable_fsRouter as fsRouter } from 'waku/router/server';

declare global {
interface ImportMeta {
Expand Down
2 changes: 1 addition & 1 deletion examples/12_nossr/src/entries.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/// <reference types="vite/client" />

import { unstable_defineEntries as defineEntries } from 'waku/minimal/server';
import { fsRouter } from 'waku/router/server';
import { unstable_fsRouter as fsRouter } from 'waku/router/server';

const router = fsRouter(
import.meta.url,
Expand Down
2 changes: 1 addition & 1 deletion packages/waku/src/client.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/**
* Highly experimental, the name might change.
*/
export const allowServer = <T>(x: T) => x;
export const unstable_allowServer = <T>(x: T) => x;
1 change: 1 addition & 0 deletions packages/waku/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface Config {
/**
* The base path for serve HTTP.
* Defaults to "/".
* TODO https://github.com/dai-shi/waku/issues/698
*/
basePath?: string;
/**
Expand Down
8 changes: 4 additions & 4 deletions packages/waku/src/lib/builder/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import type { ReactNode } from 'react';

import type { Config } from '../../config.js';
import {
setAllEnvInternal,
iterateSerializablePlatformDataInternal,
INTERNAL_setAllEnv,
INTERNAL_iterateSerializablePlatformData,
unstable_getBuildOptions,
} from '../../server.js';
import type { EntriesPrd } from '../types.js';
Expand Down Expand Up @@ -747,7 +747,7 @@ export async function build(options: {
filePathToFileURL(distEntriesFile)
);

setAllEnvInternal(env);
INTERNAL_setAllEnv(env);
const cssAssets = clientBuildOutput.output.flatMap(({ type, fileName }) =>
type === 'asset' && fileName.endsWith('.css') ? [fileName] : [],
);
Expand All @@ -770,7 +770,7 @@ export async function build(options: {
await mkdir(joinPath(rootDir, config.distDir, DIST_PLATFORM_DATA), {
recursive: true,
});
for (const [key, data] of iterateSerializablePlatformDataInternal()) {
for (const [key, data] of INTERNAL_iterateSerializablePlatformData()) {
keys.add(key);
const destFile = joinPath(
rootDir,
Expand Down
8 changes: 4 additions & 4 deletions packages/waku/src/lib/middleware/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import type { ReactNode } from 'react';
import { resolveConfig, extractPureConfig } from '../config.js';
import type { PureConfig } from '../config.js';
import {
setAllEnvInternal,
setPlatformDataLoaderInternal,
INTERNAL_setAllEnv,
INTERNAL_setPlatformDataLoader,
} from '../../server.js';
import type { HandleRequest, HandlerRes } from '../types.js';
import type { Middleware, HandlerContext } from './types.js';
Expand Down Expand Up @@ -71,7 +71,7 @@ const getInput = async (

export const handler: Middleware = (options) => {
const env = options.env || {};
setAllEnvInternal(env);
INTERNAL_setAllEnv(env);
const entriesPromise =
options.cmd === 'start'
? options.loadEntries()
Expand All @@ -80,7 +80,7 @@ export const handler: Middleware = (options) => {
options.cmd === 'start'
? entriesPromise.then(async (entries) => {
if (entries.loadPlatformData) {
setPlatformDataLoaderInternal(entries.loadPlatformData);
INTERNAL_setPlatformDataLoader(entries.loadPlatformData);
}
return resolveConfig(await entries.loadConfig());
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { randomBytes } from 'node:crypto';
import type { Plugin } from 'vite';

import {
iterateSerializablePlatformDataInternal,
INTERNAL_iterateSerializablePlatformData,
unstable_getBuildOptions,
} from '../../server.js';
import { SRC_ENTRIES } from '../constants.js';
Expand Down Expand Up @@ -215,7 +215,7 @@ export function deployCloudflarePlugin(opts: {
mkdirSync(path.join(workerDistDir, DIST_PLATFORM_DATA), {
recursive: true,
});
for (const [key, data] of iterateSerializablePlatformDataInternal()) {
for (const [key, data] of INTERNAL_iterateSerializablePlatformData()) {
keys.add(key);
const destFile = path.join(
workerDistDir,
Expand Down
2 changes: 1 addition & 1 deletion packages/waku/src/lib/plugins/vite-plugin-rsc-managed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const getManagedEntries = (
srcDir: string,
pagesDir: string,
) => `
import { fsRouter } from 'waku/router/server';
import { unstable_fsRouter as fsRouter } from 'waku/router/server';

export default fsRouter(
'${filePathToFileURL(filePath)}',
Expand Down
8 changes: 4 additions & 4 deletions packages/waku/src/lib/plugins/vite-plugin-rsc-transform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const transformClient = (
const exportNames = collectExportNames(mod);
let newCode = `
import { createServerReference } from 'react-server-dom-webpack/client';
import { callServerRsc } from 'waku/minimal/client';
import { unstable_callServerRsc as callServerRsc } from 'waku/minimal/client';
`;
for (const name of exportNames) {
newCode += `
Expand Down Expand Up @@ -189,14 +189,14 @@ const transformExportedClientThings = (
});
};
// Pass 1: find allowServer identifier
let allowServer = 'allowServer';
let allowServer = 'unstable_allowServer';
for (const item of mod.body) {
if (item.type === 'ImportDeclaration') {
if (item.source.value === 'waku/client') {
for (const specifier of item.specifiers) {
if (specifier.type === 'ImportSpecifier') {
if (specifier.local.value === allowServer && specifier.imported) {
allowServer = specifier.imported.value;
if (specifier.imported?.value === allowServer) {
allowServer = specifier.local.value;
break;
}
}
Expand Down
6 changes: 3 additions & 3 deletions packages/waku/src/lib/renderers/html.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export async function renderHtml(
const {
default: { createFromReadableStream },
} = modules.rsdwClient as { default: typeof RSDWClientType };
const { ServerRootInternal: ServerRoot } =
const { INTERNAL_ServerRoot } =
modules.wakuMinimalClient as typeof WakuMinimalClientType;

const stream = await renderRsc(config, ctx, elements);
Expand Down Expand Up @@ -226,8 +226,8 @@ export async function renderHtml(
try {
const readable = await renderToReadableStream(
createElement(
ServerRoot as FunctionComponent<
Omit<ComponentProps<typeof ServerRoot>, 'children'>
INTERNAL_ServerRoot as FunctionComponent<
Omit<ComponentProps<typeof INTERNAL_ServerRoot>, 'children'>
>,
{ elementsPromise },
htmlNode as any,
Expand Down
8 changes: 4 additions & 4 deletions packages/waku/src/minimal/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ const defaultFetchCache: FetchCache = {};
* callServer callback
* This is not a public API.
*/
export const callServerRsc = async (
export const unstable_callServerRsc = async (
funcId: string,
args: unknown[],
fetchCache = defaultFetchCache,
Expand All @@ -108,7 +108,7 @@ export const callServerRsc = async (
const createData = (responsePromise: Promise<Response>) =>
createFromFetch<Elements>(checkStatus(responsePromise), {
callServer: (funcId: string, args: unknown[]) =>
callServerRsc(funcId, args, fetchCache),
unstable_callServerRsc(funcId, args, fetchCache),
});
const url = BASE_PATH + encodeRscPath(encodeFuncId(funcId));
const responsePromise =
Expand Down Expand Up @@ -154,7 +154,7 @@ export const fetchRsc = (
const createData = (responsePromise: Promise<Response>) =>
createFromFetch<Elements>(checkStatus(responsePromise), {
callServer: (funcId: string, args: unknown[]) =>
callServerRsc(funcId, args, fetchCache),
unstable_callServerRsc(funcId, args, fetchCache),
});
const prefetched = ((globalThis as any).__WAKU_PREFETCHED__ ||= {});
const url = BASE_PATH + encodeRscPath(rscPath);
Expand Down Expand Up @@ -359,7 +359,7 @@ export const Children = () => use(ChildrenContext);
* ServerRoot for SSR
* This is not a public API.
*/
export const ServerRootInternal = ({
export const INTERNAL_ServerRoot = ({
elementsPromise,
children,
}: {
Expand Down
2 changes: 1 addition & 1 deletion packages/waku/src/router/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ export function Router({
* ServerRouter for SSR
* This is not a public API.
*/
export function ServerRouter({ route }: { route: RouteProps }) {
export function INTERNAL_ServerRouter({ route }: { route: RouteProps }) {
const routeElement = createElement(Slot, { id: getRouteSlotId(route.path) });
const rootElement = createElement(
Slot,
Expand Down
6 changes: 3 additions & 3 deletions packages/waku/src/router/define-router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
} from './common.js';
import { getPathMapping, path2regexp } from '../lib/utils/path.js';
import type { PathSpec } from '../lib/utils/path.js';
import { ServerRouter } from './client.js';
import { INTERNAL_ServerRouter } from './client.js';
import { getContext } from '../middleware/context.js';
import { stringToStream } from '../lib/utils/stream.js';

Expand Down Expand Up @@ -318,7 +318,7 @@ export function unstable_defineRouter(fns: {
if (!entries) {
return null;
}
const html = createElement(ServerRouter, {
const html = createElement(INTERNAL_ServerRouter, {
route: { path: pathname, query, hash: '' },
});
const actionResult =
Expand Down Expand Up @@ -412,7 +412,7 @@ globalThis.__WAKU_ROUTER_PREFETCH__ = (path) => {
(specs.is404 ? 'globalThis.__WAKU_ROUTER_404__ = true;' : '');
const entries = entriesCache.get(pathname);
if (specs.isStatic && entries) {
const html = createElement(ServerRouter, {
const html = createElement(INTERNAL_ServerRouter, {
route: { path: pathname, query: '', hash: '' },
});
return {
Expand Down
2 changes: 1 addition & 1 deletion packages/waku/src/router/fs-router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { EXTENSIONS } from '../lib/constants.js';

const DO_NOT_BUNDLE = '';

export function fsRouter(
export function unstable_fsRouter(
importMetaUrl: string,
loadPage: (file: string) => Promise<any> | undefined,
pages: string,
Expand Down
2 changes: 1 addition & 1 deletion packages/waku/src/router/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ export {
unstable_rerenderRoute,
} from './define-router.js';
export { createPages } from './create-pages.js';
export { fsRouter } from './fs-router.js';
export { unstable_fsRouter } from './fs-router.js';
6 changes: 3 additions & 3 deletions packages/waku/src/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { getContext } from './middleware/context.js';
/**
* This is an internal function and not for public use.
*/
export function setAllEnvInternal(newEnv: Readonly<Record<string, string>>) {
export function INTERNAL_setAllEnv(newEnv: Readonly<Record<string, string>>) {
(globalThis as any).__WAKU_SERVER_ENV__ = newEnv;
}

Expand All @@ -17,7 +17,7 @@ export function getEnv(key: string): string | undefined {
/**
* This is an internal function and not for public use.
*/
export function iterateSerializablePlatformDataInternal(): Iterable<
export function INTERNAL_iterateSerializablePlatformData(): Iterable<
[string, unknown]
> {
const platformData: Record<string, [unknown, boolean]> = ((
Expand All @@ -31,7 +31,7 @@ export function iterateSerializablePlatformDataInternal(): Iterable<
/**
* This is an internal function and not for public use.
*/
export function setPlatformDataLoaderInternal(
export function INTERNAL_setPlatformDataLoader(
loader: (key: string) => Promise<unknown>,
): void {
(globalThis as any).__WAKU_SERVER_PLATFORM_DATA_LOADER__ = loader;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function App() {

import { Component, createContext, useContext, memo } from 'react';
import { atom } from 'jotai/vanilla';
import { allowServer } from 'waku/client';
import { unstable_allowServer as allowServer } from 'waku/client';

const initialCount = 1;
const TWO = 2;
Expand Down Expand Up @@ -440,7 +440,7 @@ export default async function log4(mesg) {
expect(await transform(code, '/src/func.ts')).toMatchInlineSnapshot(`
"
import { createServerReference } from 'react-server-dom-webpack/client';
import { callServerRsc } from 'waku/minimal/client';
import { unstable_callServerRsc as callServerRsc } from 'waku/minimal/client';

export const log1 = createServerReference('/src/func.ts#log1', callServerRsc);

Expand Down
Loading