diff options
author | 2021-11-02 23:10:40 -0700 | |
---|---|---|
committer | 2021-11-02 23:10:40 -0700 | |
commit | 92e5fe9fd5b31d8b0ac8327a221b20dd03218502 (patch) | |
tree | ec29767d18dd3e0c540ab612ab2cf2c258e04a9e | |
parent | b107ac16599b67cd050977531914b774adcceead (diff) | |
download | bun-92e5fe9fd5b31d8b0ac8327a221b20dd03218502.tar.gz bun-92e5fe9fd5b31d8b0ac8327a221b20dd03218502.tar.zst bun-92e5fe9fd5b31d8b0ac8327a221b20dd03218502.zip |
Next.js 12 support
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | examples/next/package.json | 4 | ||||
-rw-r--r-- | packages/bun-framework-next/README.md | 22 | ||||
-rw-r--r-- | packages/bun-framework-next/client.development.tsx | 78 | ||||
-rw-r--r-- | packages/bun-framework-next/page-loader.ts | 4 | ||||
-rw-r--r-- | packages/bun-framework-next/polyfills.tsx | 5 | ||||
-rw-r--r-- | packages/bun-framework-next/renderDocument.tsx | 20 | ||||
-rw-r--r-- | packages/bun-framework-next/text-encoder-polyfill.js | 302 |
8 files changed, 409 insertions, 28 deletions
@@ -76,7 +76,7 @@ Here's what doesn't work yet: - locales, zones, `assetPrefix` (workaround: change `--origin \"http://localhsot:3000/assetPrefixInhere\"`) - `next/image` is polyfilled to a regular `<img src>` tag. - `proxy` and anything else in `next.config.js` -- API routes +- API routes, middleware (middleware is easier to support though! similar SSR API) When using Next.js, Bun automatically reads configuration from `.env.local`, `.env.development` and `.env` (in that order). `process.env.NEXT_PUBLIC_` and `process.env.NEXT_` automatically are replaced via `--define`. diff --git a/examples/next/package.json b/examples/next/package.json index 55c57d6a9..6acde1e1e 100644 --- a/examples/next/package.json +++ b/examples/next/package.json @@ -10,8 +10,8 @@ }, "devDependencies": { "@types/react": "^17.0.19", - "bun-framework-next": "^0.0.0-21", - "typescript": "^4.3.5" + "bun-framework-next": "^12", + "typescript": "^4.4.5" }, "bun-create": { "postinstall": [ diff --git a/packages/bun-framework-next/README.md b/packages/bun-framework-next/README.md new file mode 100644 index 000000000..6c3d3e324 --- /dev/null +++ b/packages/bun-framework-next/README.md @@ -0,0 +1,22 @@ +# bun-framework-next + +This package lets you use Next.js 12 with Bun. This readme assumes you already installed Bun. + +To start a new project: + +```bash +bun create next --open +``` + +To use Next.js 12 with an existing project: + +```bash +npm install bun-framework-next +bun bun --use next +``` + +Launch bun: + +```bash +bun +``` diff --git a/packages/bun-framework-next/client.development.tsx b/packages/bun-framework-next/client.development.tsx index df58151f9..dcc1d915c 100644 --- a/packages/bun-framework-next/client.development.tsx +++ b/packages/bun-framework-next/client.development.tsx @@ -279,6 +279,10 @@ function AppContainer({ ); } +let reactRoot: any = null; + +const USE_REACT_18 = "hydrateRoot" in ReactDOM; + export async function _boot(EntryPointNamespace, isError) { NextRouteLoader.default.getClientBuildManifest = () => Promise.resolve({}); @@ -338,25 +342,31 @@ export async function _boot(EntryPointNamespace, isError) { }); globalThis.next.router = router; + const domEl = document.querySelector("#__next"); + const reactEl = ( + <TopLevelRender + App={CachedApp} + Component={PageComponent} + props={hydrateProps} + /> + ); - if (isError) { - ReactDOM.render( - <TopLevelRender - App={CachedApp} - Component={PageComponent} - props={hydrateProps} - />, - document.querySelector("#__next") - ); + if (USE_REACT_18) { + if (!reactRoot) { + // Unlike with createRoot, you don't need a separate root.render() call here + reactRoot = (isError ? ReactDOM.createRoot : ReactDOM.hydrateRoot)( + domEl, + reactEl + ); + } else { + reactRoot.render(reactEl); + } } else { - ReactDOM.hydrate( - <TopLevelRender - App={CachedApp} - Component={PageComponent} - props={hydrateProps} - />, - document.querySelector("#__next") - ); + if (isError) { + ReactDOM.render(reactEl, domEl); + } else { + ReactDOM.hydrate(reactEl, domEl); + } } } @@ -369,23 +379,41 @@ function TopLevelRender({ App, Component, props, scroll }) { } export function render(props) { - ReactDOM.render( - <TopLevelRender {...props} />, - document.querySelector("#__next") - ); + if (USE_REACT_18) { + reactRoot.render(<TopLevelRender {...props} />); + } else { + ReactDOM.render( + <TopLevelRender {...props} />, + document.getElementById("__next") + ); + } } export function renderError(e) { - ReactDOM.render( + const reactEl = ( <AppContainer> <App Component={<div>UH OH!!!!</div>} pageProps={data.props}></App> - </AppContainer>, - document.querySelector("#__next") + </AppContainer> ); + + if (USE_REACT_18) { + if (!reactRoot) { + const domEl = document.querySelector("#__next"); + + // Unlike with createRoot, you don't need a separate root.render() call here + reactRoot = ReactDOM.createRoot(domEl, reactEl); + } else { + reactRoot.render(reactEl); + } + } else { + const domEl = document.querySelector("#__next"); + + ReactDOM.render(reactEl, domEl); + } } globalThis.next = { - version: "11.1.2", + version: "12.0.2", emitter, render, renderError, diff --git a/packages/bun-framework-next/page-loader.ts b/packages/bun-framework-next/page-loader.ts index b0c69a1c2..7bb6c2a25 100644 --- a/packages/bun-framework-next/page-loader.ts +++ b/packages/bun-framework-next/page-loader.ts @@ -62,6 +62,10 @@ export default class PageLoader extends NextPageLoader { return this.pageList; } + async getMiddlewareList() { + return []; + } + cssQueue = []; onImportCSS = (event) => { diff --git a/packages/bun-framework-next/polyfills.tsx b/packages/bun-framework-next/polyfills.tsx index b000c1f54..474ee6ec9 100644 --- a/packages/bun-framework-next/polyfills.tsx +++ b/packages/bun-framework-next/polyfills.tsx @@ -21,3 +21,8 @@ React.Children.only = function (children) { return onlyChildPolyfill(children); }; globalThis.URL = URL; + +import { TextEncoder, TextDecoder } from "./text-encoder-polyfill"; + +globalThis.TextEncoder ||= TextEncoder; +globalThis.TextDecoder ||= TextDecoder; diff --git a/packages/bun-framework-next/renderDocument.tsx b/packages/bun-framework-next/renderDocument.tsx index 463395863..615224f0d 100644 --- a/packages/bun-framework-next/renderDocument.tsx +++ b/packages/bun-framework-next/renderDocument.tsx @@ -243,6 +243,7 @@ function renderDocument( scriptLoader, locale, disableOptimizedLoading, + useMaybeDeferContent, ...docProps, }; return ( @@ -567,6 +568,17 @@ export async function render({ </AppContainer> ); }, + defaultGetInitialProps: async ( + docCtx: DocumentContext + ): Promise<DocumentInitialProps> => { + const enhanceApp = (AppComp: any) => { + return (props: any) => <AppComp {...props} />; + }; + + const { html, head } = await docCtx.renderPage({ enhanceApp }); + // const styles = jsxStyleRegistry.styles(); + return { html, head }; + }, }; var props = await loadGetInitialProps(AppComponent, { @@ -789,6 +801,7 @@ export async function render({ isPreview: isPreview === true ? true : undefined, autoExport: isAutoExport === true ? true : undefined, nextExport: nextExport === true ? true : undefined, + useMaybeDeferContent, }); const bodyRenderIdx = html.indexOf(BODY_RENDER_TARGET); html = @@ -812,3 +825,10 @@ export async function render({ ); } } + +export function useMaybeDeferContent( + _name: string, + contentFn: () => JSX.Element +): [boolean, JSX.Element] { + return [false, contentFn()]; +} diff --git a/packages/bun-framework-next/text-encoder-polyfill.js b/packages/bun-framework-next/text-encoder-polyfill.js new file mode 100644 index 000000000..3dd95009f --- /dev/null +++ b/packages/bun-framework-next/text-encoder-polyfill.js @@ -0,0 +1,302 @@ +/* + * Copyright 2017 Sam Thorogood. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not + * use this file except in compliance with the License. You may obtain a copy of + * the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + */ + +/** + * @fileoverview Polyfill for TextEncoder and TextDecoder. + * + * You probably want `text.min.js`, and not this file directly. + */ + +// used for FastTextDecoder +const validUtfLabels = ["utf-8", "utf8", "unicode-1-1-utf-8"]; + +/** + * @constructor + */ +function FastTextEncoder() { + // This does not accept an encoding, and always uses UTF-8: + // https://www.w3.org/TR/encoding/#dom-textencoder +} + +Object.defineProperty(FastTextEncoder.prototype, "encoding", { + value: "utf-8", +}); + +/** + * @param {string} string + * @param {{stream: boolean}=} options + * @return {!Uint8Array} + */ +FastTextEncoder.prototype["encode"] = function ( + string, + options = { stream: false } +) { + if (options.stream) { + throw new Error(`Failed to encode: the 'stream' option is unsupported.`); + } + + let pos = 0; + const len = string.length; + + let at = 0; // output position + let tlen = Math.max(32, len + (len >>> 1) + 7); // 1.5x size + let target = new Uint8Array((tlen >>> 3) << 3); // ... but at 8 byte offset + + while (pos < len) { + let value = string.charCodeAt(pos++); + if (value >= 0xd800 && value <= 0xdbff) { + // high surrogate + if (pos < len) { + const extra = string.charCodeAt(pos); + if ((extra & 0xfc00) === 0xdc00) { + ++pos; + value = ((value & 0x3ff) << 10) + (extra & 0x3ff) + 0x10000; + } + } + if (value >= 0xd800 && value <= 0xdbff) { + continue; // drop lone surrogate + } + } + + // expand the buffer if we couldn't write 4 bytes + if (at + 4 > target.length) { + tlen += 8; // minimum extra + tlen *= 1.0 + (pos / string.length) * 2; // take 2x the remaining + tlen = (tlen >>> 3) << 3; // 8 byte offset + + const update = new Uint8Array(tlen); + update.set(target); + target = update; + } + + if ((value & 0xffffff80) === 0) { + // 1-byte + target[at++] = value; // ASCII + continue; + } else if ((value & 0xfffff800) === 0) { + // 2-byte + target[at++] = ((value >>> 6) & 0x1f) | 0xc0; + } else if ((value & 0xffff0000) === 0) { + // 3-byte + target[at++] = ((value >>> 12) & 0x0f) | 0xe0; + target[at++] = ((value >>> 6) & 0x3f) | 0x80; + } else if ((value & 0xffe00000) === 0) { + // 4-byte + target[at++] = ((value >>> 18) & 0x07) | 0xf0; + target[at++] = ((value >>> 12) & 0x3f) | 0x80; + target[at++] = ((value >>> 6) & 0x3f) | 0x80; + } else { + continue; // out of range + } + + target[at++] = (value & 0x3f) | 0x80; + } + + // Use subarray if slice isn't supported (IE11). This will use more memory + // because the original array still exists. + return target.slice ? target.slice(0, at) : target.subarray(0, at); +}; + +/** + * @constructor + * @param {string=} utfLabel + * @param {{fatal: boolean}=} options + */ +function FastTextDecoder(utfLabel = "utf-8", options = { fatal: false }) { + if (validUtfLabels.indexOf(utfLabel.toLowerCase()) === -1) { + throw new RangeError( + `Failed to construct 'TextDecoder': The encoding label provided ('${utfLabel}') is invalid.` + ); + } + if (options.fatal) { + throw new Error( + `Failed to construct 'TextDecoder': the 'fatal' option is unsupported.` + ); + } +} + +Object.defineProperty(FastTextDecoder.prototype, "encoding", { + value: "utf-8", +}); + +Object.defineProperty(FastTextDecoder.prototype, "fatal", { value: false }); + +Object.defineProperty(FastTextDecoder.prototype, "ignoreBOM", { + value: false, +}); + +/** + * @param {!Uint8Array} bytes + * @return {string} + */ +function decodeBuffer(bytes) { + return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength).toString( + "utf-8" + ); +} + +/** + * @param {!Uint8Array} bytes + * @return {string} + */ +function decodeSyncXHR(bytes) { + const b = new Blob([bytes], { type: "text/plain;charset=UTF-8" }); + const u = URL.createObjectURL(b); + + // This hack will fail in non-Edgium Edge because sync XHRs are disabled (and + // possibly in other places), so ensure there's a fallback call. + try { + const x = new XMLHttpRequest(); + x.open("GET", u, false); + x.send(); + return x.responseText; + } catch (e) { + return decodeFallback(bytes); + } finally { + URL.revokeObjectURL(u); + } +} + +/** + * @param {!Uint8Array} bytes + * @return {string} + */ +function decodeFallback(bytes) { + let inputIndex = 0; + + // Create a working buffer for UTF-16 code points, but don't generate one + // which is too large for small input sizes. UTF-8 to UCS-16 conversion is + // going to be at most 1:1, if all code points are ASCII. The other extreme + // is 4-byte UTF-8, which results in two UCS-16 points, but this is still 50% + // fewer entries in the output. + const pendingSize = Math.min(256 * 256, bytes.length + 1); + const pending = new Uint16Array(pendingSize); + const chunks = []; + let pendingIndex = 0; + + for (;;) { + const more = inputIndex < bytes.length; + + // If there's no more data or there'd be no room for two UTF-16 values, + // create a chunk. This isn't done at the end by simply slicing the data + // into equal sized chunks as we might hit a surrogate pair. + if (!more || pendingIndex >= pendingSize - 1) { + // nb. .apply and friends are *really slow*. Low-hanging fruit is to + // expand this to literally pass pending[0], pending[1], ... etc, but + // the output code expands pretty fast in this case. + chunks.push( + String.fromCharCode.apply(null, pending.subarray(0, pendingIndex)) + ); + + if (!more) { + return chunks.join(""); + } + + // Move the buffer forward and create another chunk. + bytes = bytes.subarray(inputIndex); + inputIndex = 0; + pendingIndex = 0; + } + + // The native TextDecoder will generate "REPLACEMENT CHARACTER" where the + // input data is invalid. Here, we blindly parse the data even if it's + // wrong: e.g., if a 3-byte sequence doesn't have two valid continuations. + + const byte1 = bytes[inputIndex++]; + if ((byte1 & 0x80) === 0) { + // 1-byte or null + pending[pendingIndex++] = byte1; + } else if ((byte1 & 0xe0) === 0xc0) { + // 2-byte + const byte2 = bytes[inputIndex++] & 0x3f; + pending[pendingIndex++] = ((byte1 & 0x1f) << 6) | byte2; + } else if ((byte1 & 0xf0) === 0xe0) { + // 3-byte + const byte2 = bytes[inputIndex++] & 0x3f; + const byte3 = bytes[inputIndex++] & 0x3f; + pending[pendingIndex++] = ((byte1 & 0x1f) << 12) | (byte2 << 6) | byte3; + } else if ((byte1 & 0xf8) === 0xf0) { + // 4-byte + const byte2 = bytes[inputIndex++] & 0x3f; + const byte3 = bytes[inputIndex++] & 0x3f; + const byte4 = bytes[inputIndex++] & 0x3f; + + // this can be > 0xffff, so possibly generate surrogates + let codepoint = + ((byte1 & 0x07) << 0x12) | (byte2 << 0x0c) | (byte3 << 0x06) | byte4; + if (codepoint > 0xffff) { + // codepoint &= ~0x10000; + codepoint -= 0x10000; + pending[pendingIndex++] = ((codepoint >>> 10) & 0x3ff) | 0xd800; + codepoint = 0xdc00 | (codepoint & 0x3ff); + } + pending[pendingIndex++] = codepoint; + } else { + // invalid initial byte + } + } +} + +// Decoding a string is pretty slow, but use alternative options where possible. +let decodeImpl = decodeFallback; +if (typeof Buffer === "function" && Buffer.from) { + // Buffer.from was added in Node v5.10.0 (2015-11-17). + decodeImpl = decodeBuffer; +} else if ( + typeof Blob === "function" && + typeof URL === "function" && + typeof URL.createObjectURL === "function" +) { + // Blob and URL.createObjectURL are available from IE10, Safari 6, Chrome 19 + // (all released in 2012), Firefox 19 (2013), ... + decodeImpl = decodeSyncXHR; +} + +/** + * @param {(!ArrayBuffer|!ArrayBufferView)} buffer + * @param {{stream: boolean}=} options + * @return {string} + */ +FastTextDecoder.prototype["decode"] = function ( + buffer, + options = { stream: false } +) { + if (options["stream"]) { + throw new Error(`Failed to decode: the 'stream' option is unsupported.`); + } + + let bytes; + + if (buffer instanceof Uint8Array) { + // Accept Uint8Array instances as-is. + bytes = buffer; + } else if (buffer.buffer instanceof ArrayBuffer) { + // Look for ArrayBufferView, which isn't a real type, but basically + // represents all the valid TypedArray types plus DataView. They all have + // ".buffer" as an instance of ArrayBuffer. + bytes = new Uint8Array(buffer.buffer); + } else { + // The only other valid argument here is that "buffer" is an ArrayBuffer. + // We also try to convert anything else passed to a Uint8Array, as this + // catches anything that's array-like. Native code would throw here. + bytes = new Uint8Array(buffer); + } + + return decodeImpl(/** @type {!Uint8Array} */ (bytes)); +}; + +export { FastTextEncoder as TextEncoder }; +export { FastTextDecoder as TextDecoder }; |