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

feat(og-gen): Implement middleware and hooks #10469

Merged
merged 58 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
ec98e53
WIP
dac09 Apr 10, 2024
7dcce32
Get tests working for og plugin
dac09 Apr 11, 2024
d901f65
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 12, 2024
422e36a
Move stuff to new package
dac09 Apr 12, 2024
ab12cc4
Update packagejson
dac09 Apr 12, 2024
751b5c5
Get around esm issue
dac09 Apr 12, 2024
6e297e9
Fix TS errors errywhere
dac09 Apr 12, 2024
bf03f82
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 12, 2024
e7eecd8
Undo internal package.json change
dac09 Apr 12, 2024
3d807f5
Add cjs wrappers for middleware and hooks
dac09 Apr 12, 2024
fd747ac
Export middleware types
dac09 Apr 12, 2024
a308c12
Rename file for middleware
dac09 Apr 12, 2024
1226f55
Tweaks to get it further
dac09 Apr 12, 2024
f7ac767
Get it working for serve!
dac09 Apr 12, 2024
348ea7f
Get it to import component in dev too
dac09 Apr 12, 2024
8fe05b2
Only update inputs for ssrBuilds
dac09 Apr 12, 2024
3eff5fa
Update comments
dac09 Apr 15, 2024
0f5e872
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 16, 2024
7d3adb8
set type=module and build for both esm and cjs
Tobbe Apr 16, 2024
3d95f45
Merge branch 'feat/dc-rc-og-gen-mw-p2' of github.com:redwoodjs/redwoo…
dac09 Apr 16, 2024
90d504d
Revert "set type=module and build for both esm and cjs"
dac09 Apr 16, 2024
4e466a0
Fix loading of CSS and Images in both prod and dev!
dac09 Apr 16, 2024
f2ee7c0
Update test
dac09 Apr 17, 2024
928e203
Use dist imports, leave moduleResolution as is
dac09 Apr 17, 2024
7a3e09c
Update ts templates and fixtures
dac09 Apr 17, 2024
d400fb4
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 17, 2024
871d04f
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 18, 2024
e79e6ac
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 18, 2024
99b6054
Initial tests for middleware
dac09 Apr 18, 2024
971607c
Add more tests for sub functions
dac09 Apr 18, 2024
e015b8a
Fix build and more tests around the middleware
dac09 Apr 18, 2024
ea17832
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 18, 2024
885134a
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 19, 2024
0ed26f7
Update JS Template
dac09 Apr 19, 2024
9679058
That was hard!
dac09 Apr 19, 2024
95edfbd
LINT
dac09 Apr 19, 2024
e40e08b
Lint fixes
dac09 Apr 22, 2024
3bcb47b
Fix types
dac09 Apr 22, 2024
bcc7dae
Update dependency list
dac09 Apr 22, 2024
bae0489
Update scaffold generator to look for index.css instead of Routes
dac09 Apr 22, 2024
4cf78fb
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 22, 2024
e03e399
Reorder index and scaffold css
dac09 Apr 22, 2024
e16eca4
Try posix paths
dac09 Apr 22, 2024
c7e707d
Add changesets
dac09 Apr 22, 2024
2e1d061
Ensure posix path again
dac09 Apr 22, 2024
f534c6a
Adds hooks test file
cannikin Apr 22, 2024
b857fe3
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 23, 2024
fb4b091
Update webpack entry too
dac09 Apr 23, 2024
60a4fc3
Update changeset
dac09 Apr 23, 2024
beb4053
Add tests for screenshot size
dac09 Apr 23, 2024
b8625ab
Add test for default viewport size too
dac09 Apr 23, 2024
3c72c01
Update entry.server template for streaming ssr
dac09 Apr 23, 2024
78dd721
Update prerender too
dac09 Apr 23, 2024
496d90f
Always include pathname in hook output, fixed bad origin mock in tests
cannikin Apr 24, 2024
ba007f1
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 24, 2024
e05590d
Merge branch 'main' into feat/dc-rc-og-gen-mw-p2
dac09 Apr 25, 2024
8f2de47
Apply suggestions from code review
dac09 Apr 26, 2024
b9dd681
Merge branch 'main' of github.com:redwoodjs/redwood into feat/dc-rc-o…
dac09 Apr 26, 2024
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
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"Flightcontrol",
"graphiql",
"memfs",
"OGIMAGE",
"opentelemetry",
"pino",
"Pistorius",
Expand Down
4 changes: 1 addition & 3 deletions __fixtures__/test-project/web/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ import { FatalErrorBoundary, RedwoodProvider } from '@redwoodjs/web'
import { RedwoodApolloProvider } from '@redwoodjs/web/apollo'

import FatalErrorPage from 'src/pages/FatalErrorPage'
import Routes from 'src/Routes'

import { AuthProvider, useAuth } from './auth'

import './scaffold.css'
import './index.css'
interface AppProps {
children?: ReactNode
Expand All @@ -19,7 +17,7 @@ const App = ({ children }: AppProps) => (
<RedwoodProvider titleTemplate="%PageTitle | %AppTitle">
<AuthProvider>
<RedwoodApolloProvider useAuth={useAuth}>
{children ? children : <Routes />}
{children}
</RedwoodApolloProvider>
</AuthProvider>
</RedwoodProvider>
Expand Down
15 changes: 13 additions & 2 deletions __fixtures__/test-project/web/src/entry.client.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { hydrateRoot, createRoot } from 'react-dom/client'

import App from './App'
import Routes from './Routes'

/**
* When `#redwood-app` isn't empty then it's very likely that you're using
* prerendering. So React attaches event listeners to the existing markup
Expand All @@ -16,8 +18,17 @@ if (!redwoodAppElement) {
}

if (redwoodAppElement.children?.length > 0) {
hydrateRoot(redwoodAppElement, <App />)
hydrateRoot(
redwoodAppElement,
<App>
<Routes />
</App>
)
} else {
const root = createRoot(redwoodAppElement)
root.render(<App />)
root.render(
<App>
<Routes />
</App>
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { hydrateRoot, createRoot } from 'react-dom/client'

import App from './App'
import { Document } from './Document'
import Routes from './Routes'

/**
* When `#redwood-app` isn't empty then it's very likely that you're using
Expand All @@ -15,14 +16,18 @@ if (redwoodAppElement.children?.length > 0) {
hydrateRoot(
document,
<Document css={window.__assetMap?.()?.css}>
<App />
<App>
<Routes />
</App>
</Document>
)
} else {
const root = createRoot(document)
root.render(
<Document css={window.__assetMap?.()?.css}>
<App />
<App>
<Routes />
</App>
</Document>
)
}
5 changes: 1 addition & 4 deletions packages/create-redwood-app/templates/js/web/src/App.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@ import { FatalErrorBoundary, RedwoodProvider } from '@redwoodjs/web'
import { RedwoodApolloProvider } from '@redwoodjs/web/apollo'

import FatalErrorPage from 'src/pages/FatalErrorPage'
import Routes from 'src/Routes'

import './index.css'

const App = ({ children }) => (
<FatalErrorBoundary page={FatalErrorPage}>
<RedwoodProvider titleTemplate="%PageTitle | %AppTitle">
<RedwoodApolloProvider>
{children ? children : <Routes />}
</RedwoodApolloProvider>
<RedwoodApolloProvider>{children}</RedwoodApolloProvider>
</RedwoodProvider>
</FatalErrorBoundary>
)
Expand Down
15 changes: 13 additions & 2 deletions packages/create-redwood-app/templates/js/web/src/entry.client.jsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { hydrateRoot, createRoot } from 'react-dom/client'

import App from './App'
import Routes from './Routes'

/**
* When `#redwood-app` isn't empty then it's very likely that you're using
* prerendering. So React attaches event listeners to the existing markup
Expand All @@ -16,8 +18,17 @@ if (!redwoodAppElement) {
}

if (redwoodAppElement.children?.length > 0) {
hydrateRoot(redwoodAppElement, <App />)
hydrateRoot(
redwoodAppElement,
<App>
<Routes />
</App>
)
} else {
const root = createRoot(redwoodAppElement)
root.render(<App />)
root.render(
<App>
<Routes />
</App>
)
}
3 changes: 1 addition & 2 deletions packages/create-redwood-app/templates/ts/web/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
import { RedwoodApolloProvider } from '@redwoodjs/web/apollo'

import FatalErrorPage from 'src/pages/FatalErrorPage'
import Routes from 'src/Routes'

import './index.css'
interface AppProps {
Expand All @@ -14,8 +13,8 @@
const App = ({ children }: AppProps) => (
<FatalErrorBoundary page={FatalErrorPage}>
<RedwoodProvider titleTemplate="%PageTitle | %AppTitle">
<RedwoodApolloProvider>

Check warning on line 16 in packages/create-redwood-app/templates/ts/web/src/App.tsx

View workflow job for this annotation

GitHub Actions / 🏗 Build, lint, test / ubuntu-latest / node 20 latest

Replace `⏎········{children}⏎······` with `{children}`
{children ? children : <Routes />}
{children}
</RedwoodApolloProvider>
</RedwoodProvider>
</FatalErrorBoundary>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { hydrateRoot, createRoot } from 'react-dom/client'

import App from './App'
import Routes from './Routes'

/**
* When `#redwood-app` isn't empty then it's very likely that you're using
* prerendering. So React attaches event listeners to the existing markup
Expand All @@ -16,8 +18,8 @@
}

if (redwoodAppElement.children?.length > 0) {
hydrateRoot(redwoodAppElement, <App />)
hydrateRoot(redwoodAppElement, <App><Routes /></App>)

Check warning on line 21 in packages/create-redwood-app/templates/ts/web/src/entry.client.tsx

View workflow job for this annotation

GitHub Actions / 🏗 Build, lint, test / ubuntu-latest / node 20 latest

Replace `redwoodAppElement,·<App><Routes·/></App>` with `⏎····redwoodAppElement,⏎····<App>⏎······<Routes·/>⏎····</App>⏎··`
} else {
const root = createRoot(redwoodAppElement)
root.render(<App />)
root.render(<App><Routes /></App>)

Check warning on line 24 in packages/create-redwood-app/templates/ts/web/src/entry.client.tsx

View workflow job for this annotation

GitHub Actions / 🏗 Build, lint, test / ubuntu-latest / node 20 latest

Replace `<App><Routes·/></App>` with `⏎····<App>⏎······<Routes·/>⏎····</App>⏎··`
}
4 changes: 2 additions & 2 deletions packages/internal/src/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export interface RWRouteManifestItem {
routeHooks: string | null
bundle: string | null
hasParams: boolean
relativeFilePath: string | undefined
relativeFilePath: string
redirect: { to: string; permanent: boolean } | null
// Probably want isNotFound here, so we can attach a separate 404 handler
}
Expand All @@ -80,7 +80,7 @@ export interface RouteSpec extends RWRouteManifestItem {
id: string
isNotFound: boolean
filePath: string | undefined
relativeFilePath: string | undefined
relativeFilePath: string
}

export const getProjectRoutes = (): RouteSpec[] => {
Expand Down
3 changes: 3 additions & 0 deletions packages/ogimage-gen/cjsWrappers/hooks.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/* eslint-env node */

module.exports = require('../dist/hooks.js').default
3 changes: 3 additions & 0 deletions packages/ogimage-gen/cjsWrappers/middleware.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/* eslint-env node */

module.exports = require('../dist/OgImageMiddleware.js').default
16 changes: 12 additions & 4 deletions packages/ogimage-gen/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,20 @@
},
"license": "MIT",
"exports": {
".": {
"default": "./dist/index.js"
},
"./plugin": {
"import": "./dist/vite-plugin-ogimage-gen.js",
"default": "./cjsWrappers/plugin.js"
"default": "./cjsWrappers/plugin.js",
"types": "./dist/vite-plugin-ogimage-gen.d.ts"
},
"./middleware": {
"import": "./dist/OgImageMiddleware.js",
"default": "./cjsWrappers/middleware.js",
"types": "./dist/OgImageMiddleware.d.ts"
},
"./hooks": {
"import": "./dist/hooks.js",
"default": "./cjsWrappers/hooks.js",
"types": "./dist/hooks.d.ts"
}
},
"files": [
Expand Down
Loading
Loading