1
0
mirror of synced 2026-02-03 18:01:02 -05:00

Compare commits

...

14 Commits

Author SHA1 Message Date
Dillon Raphael
72b08f2269 pnpmlock 2022-06-13 15:45:47 -04:00
github-actions[bot]
2124a4d0c5 Version Packages (alpha) (#3440)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-13 15:41:12 -04:00
Dillon Raphael
8aee25c58a changeset 2022-06-13 15:37:27 -04:00
Dillon Raphael
f1003faf94 update generator template (#3439) 2022-06-13 15:35:38 -04:00
Andreas Asprou
50468a3bb0 Fix duplicate react-query clients (#3431)
* Fix duplicate react-query clients

* fix tests

* add codemod & remove queryClient export from generator templates

Co-authored-by: Dillon Raphael <dillon@creatorsneverdie.com>
2022-06-13 11:07:41 -04:00
Dillon Raphael
891d91bf4d pnpmlock 2022-06-10 16:19:50 -04:00
github-actions[bot]
f96c953457 Version Packages (alpha) (#3430)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-10 16:18:48 -04:00
Dillon Raphael
a80d2a8f77 Rename Blitz server plugin type from Middleware to RequestMiddleware (#3428)
* rename to requestMiddleware

* update plugins

* merge main

* changeset
2022-06-10 16:14:21 -04:00
beerose
b336ad05f4 Update pnpm-lock.yaml 2022-06-10 11:32:17 -07:00
github-actions[bot]
39ca0ef8bf Version Packages (alpha) (#3429)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-10 11:31:27 -07:00
Aleksandra
4cad9cca25 Add queryClient to RPC plugin exports (#3424) 2022-06-10 10:18:50 -07:00
Dillon Raphael
b6fc940bf2 pnpmlock 2022-06-10 11:21:33 -04:00
github-actions[bot]
a946dd5889 Version Packages (alpha) (#3427)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-10 11:20:25 -04:00
Dillon Raphael
e3750b049d Codemod fixes (#3420)
* change BlitzApiRequest to NextApiRequest & update import map & fail catch for custom server

* fix page consolidation when there are sub directories

* Update prisma db export/import

* Update db imports in templates

* update root types file

* update error messages + merge main + changeset

Co-authored-by: beerose <alexsandra.sikora@gmail.com>
2022-06-10 11:16:18 -04:00
52 changed files with 866 additions and 341 deletions

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/rpc": patch
---
Add queryClient to RPC Plugin exports

View File

@@ -0,0 +1,6 @@
---
"@blitzjs/codemod": patch
"@blitzjs/generator": patch
---
codemod fixes

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/codemod": patch
---
Update queryClient import in codemod

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/generator": patch
---
Update codemod and template with a new queryClient import location

View File

@@ -0,0 +1,7 @@
---
"blitz": patch
"@blitzjs/auth": patch
"@blitzjs/next": patch
---
rename middleware type for blitz server plugin

View File

@@ -22,18 +22,23 @@
"changesets": [
"big-phones-bow",
"breezy-cameras-double",
"bright-mangos-run",
"cool-doors-invent",
"dirty-monkeys-greet",
"eleven-humans-sort",
"empty-berries-rule",
"fair-wombats-sneeze",
"famous-kings-explain",
"fast-trainers-kneel",
"flat-bees-approve",
"four-meals-fry",
"gentle-dogs-reply",
"great-months-train",
"green-papayas-do",
"healthy-rice-shout",
"hot-drinks-approve",
"lovely-colts-share",
"lucky-cows-try",
"modern-cameras-pull",
"moody-squids-cheer",
"nice-starfishes-live",
@@ -45,6 +50,7 @@
"poor-peas-lick",
"poor-penguins-look",
"poor-shrimps-think",
"purple-singers-greet",
"quiet-feet-travel",
"rich-chairs-invent",
"sharp-falcons-begin",

View File

@@ -0,0 +1,7 @@
---
"@blitzjs/rpc": patch
"@blitzjs/codemod": patch
"@blitzjs/generator": patch
---
getQueryClient function & queryClient codemod updates & shared plugin config

View File

@@ -29,7 +29,7 @@
"@blitzjs/rpc": "workspace:*",
"@hookform/resolvers": "2.8.8",
"@prisma/client": "3.9.0",
"blitz": "workspace:2.0.0-alpha.34",
"blitz": "workspace:2.0.0-alpha.38",
"next": "12.1.6-canary.17",
"prisma": "3.9.0",
"react": "18.0.0",

View File

@@ -1,5 +1,31 @@
# @blitzjs/auth
## 2.0.0-alpha.38
### Patch Changes
- blitz@2.0.0-alpha.38
## 2.0.0-alpha.37
### Patch Changes
- a80d2a8f: rename middleware type for blitz server plugin
- Updated dependencies [a80d2a8f]
- blitz@2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- blitz@2.0.0-alpha.36
## 2.0.0-alpha.35
### Patch Changes
- blitz@2.0.0-alpha.35
## 2.0.0-alpha.34
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/auth",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts",
@@ -26,7 +26,7 @@
"@types/secure-password": "3.1.1",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"blitz": "2.0.0-alpha.34",
"blitz": "2.0.0-alpha.38",
"cookie": "0.4.1",
"cookie-session": "2.0.0",
"debug": "4.3.3",
@@ -39,7 +39,7 @@
"url": "0.11.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.34",
"@blitzjs/config": "workspace:2.0.0-alpha.38",
"@testing-library/react": "13.0.0",
"@testing-library/react-hooks": "7.0.2",
"@types/cookie": "0.4.1",

View File

@@ -1,4 +1,4 @@
import type {BlitzServerPlugin, Middleware, Ctx} from "blitz"
import type {BlitzServerPlugin, RequestMiddleware, Ctx} from "blitz"
import {assert} from "blitz"
import {IncomingMessage, ServerResponse} from "http"
import {PublicData, SessionModel, SessionConfigMethods} from "../shared/types"
@@ -101,7 +101,7 @@ export function AuthServerPlugin(options: AuthPluginOptions): BlitzServerPlugin<
`The cookie prefix used has invalid characters. Only alphanumeric characters, "-" and "_" character are supported`,
)
const blitzSessionMiddleware: Middleware<
const blitzSessionMiddleware: RequestMiddleware<
IncomingMessage,
ServerResponse & {blitzCtx: Ctx}
> = async (req, res, next) => {
@@ -119,6 +119,6 @@ export function AuthServerPlugin(options: AuthPluginOptions): BlitzServerPlugin<
return blitzSessionMiddleware
}
return {
middlewares: [authPluginSessionMiddleware()],
requestMiddlewares: [authPluginSessionMiddleware()],
}
}

View File

@@ -8,7 +8,7 @@ import {
connectMiddleware,
Ctx,
handleRequestWithMiddleware,
Middleware,
RequestMiddleware,
MiddlewareResponse,
secureProxyMiddleware,
} from "blitz"
@@ -79,9 +79,9 @@ export function passportAuth(config: BlitzPassportConfig): ApiHandler {
const passportMiddleware = passport.initialize()
const middleware: Middleware<ApiHandlerIncomingMessage, MiddlewareResponse<Ctx>>[] = [
connectMiddleware(cookieSessionMiddleware as Middleware),
connectMiddleware(passportMiddleware as Middleware),
const middleware: RequestMiddleware<ApiHandlerIncomingMessage, MiddlewareResponse<Ctx>>[] = [
connectMiddleware(cookieSessionMiddleware as RequestMiddleware),
connectMiddleware(passportMiddleware as RequestMiddleware),
connectMiddleware(passport.session()),
]

View File

@@ -1,5 +1,32 @@
# @blitzjs/next
## 2.0.0-alpha.38
### Patch Changes
- Updated dependencies [8aee25c5]
- @blitzjs/rpc@2.0.0-alpha.38
## 2.0.0-alpha.37
### Patch Changes
- a80d2a8f: rename middleware type for blitz server plugin
- @blitzjs/rpc@2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- Updated dependencies [4cad9cca]
- @blitzjs/rpc@2.0.0-alpha.36
## 2.0.0-alpha.35
### Patch Changes
- @blitzjs/rpc@2.0.0-alpha.35
## 2.0.0-alpha.34
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/next",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"build": "unbuild",
"dev": "pnpm predev && pnpm watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"eslint.js"
],
"dependencies": {
"@blitzjs/rpc": "2.0.0-alpha.34",
"@blitzjs/rpc": "2.0.0-alpha.38",
"@types/hoist-non-react-statics": "3.3.1",
"debug": "4.3.3",
"fs-extra": "10.0.1",
@@ -32,7 +32,7 @@
"superjson": "1.8.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.34",
"@blitzjs/config": "workspace:2.0.0-alpha.38",
"@testing-library/dom": "8.13.0",
"@testing-library/jest-dom": "5.16.3",
"@testing-library/react": "13.0.0",
@@ -43,7 +43,7 @@
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"@types/testing-library__react-hooks": "4.0.0",
"blitz": "2.0.0-alpha.34",
"blitz": "2.0.0-alpha.38",
"cross-spawn": "7.0.3",
"find-up": "4.1.0",
"lodash.frompairs": "4.0.1",

View File

@@ -13,7 +13,7 @@ import type {
BlitzServerPlugin,
Ctx as BlitzCtx,
FirstParam,
Middleware,
RequestMiddleware,
MiddlewareResponse,
} from "blitz"
import {handleRequestWithMiddleware, startWatcher, stopWatcher} from "blitz"
@@ -38,7 +38,7 @@ export type NextApiHandler = (
) => void | Promise<void>
type SetupBlitzOptions = {
plugins: BlitzServerPlugin<Middleware, Ctx>[]
plugins: BlitzServerPlugin<RequestMiddleware, Ctx>[]
}
export type BlitzGSSPHandler<TProps> = ({
@@ -60,7 +60,7 @@ export type BlitzAPIHandler = (
) => ReturnType<NextApiHandler>
export const setupBlitzServer = ({plugins}: SetupBlitzOptions) => {
const middlewares = plugins.flatMap((p) => p.middlewares)
const middlewares = plugins.flatMap((p) => p.requestMiddlewares)
const contextMiddleware = plugins.flatMap((p) => p.contextMiddleware).filter(Boolean)
const gSSP =

View File

@@ -1,5 +1,36 @@
# @blitzjs/rpc
## 2.0.0-alpha.38
### Patch Changes
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
- blitz@2.0.0-alpha.38
- @blitzjs/auth@2.0.0-alpha.38
## 2.0.0-alpha.37
### Patch Changes
- Updated dependencies [a80d2a8f]
- blitz@2.0.0-alpha.37
- @blitzjs/auth@2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- 4cad9cca: Add queryClient to RPC Plugin exports
- blitz@2.0.0-alpha.36
- @blitzjs/auth@2.0.0-alpha.36
## 2.0.0-alpha.35
### Patch Changes
- blitz@2.0.0-alpha.35
- @blitzjs/auth@2.0.0-alpha.35
## 2.0.0-alpha.34
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/rpc",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts && wait-on -d 250 ../blitz-auth/dist/index-browser.d.ts",
@@ -20,7 +20,7 @@
"dist/**"
],
"dependencies": {
"@blitzjs/auth": "2.0.0-alpha.34",
"@blitzjs/auth": "2.0.0-alpha.38",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"chalk": "^4.1.0",
@@ -30,11 +30,11 @@
"zod": "3.10.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.34",
"@blitzjs/config": "workspace:2.0.0-alpha.38",
"@types/debug": "4.1.7",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"blitz": "2.0.0-alpha.34",
"blitz": "2.0.0-alpha.38",
"next": "12.1.6-canary.17",
"react": "18.0.0",
"react-dom": "18.0.0",
@@ -43,7 +43,7 @@
"watch": "1.0.2"
},
"peerDependencies": {
"blitz": "2.0.0-alpha.34",
"blitz": "2.0.0-alpha.38",
"next": "*"
},
"publishConfig": {

View File

@@ -2,11 +2,11 @@ export * from "./rpc"
export {useQuery, usePaginatedQuery, useInfiniteQuery, useMutation} from "./react-query"
export type {MutateFunction} from "./react-query"
export {
queryClient,
getQueryKey,
getInfiniteQueryKey,
invalidateQuery,
setQueryData,
getQueryClient,
} from "./react-query-utils"
export {useQueryErrorResetBoundary, QueryClient} from "react-query"
export {dehydrate} from "react-query/hydration"

View File

@@ -54,8 +54,8 @@ export const initializeQueryClient = () => {
})
}
// Create internal QueryClient instance
export const queryClient = initializeQueryClient()
// Query client is initialised in `BlitzRpcPlugin`, and can only be used with BlitzRpcPlugin right now
export const getQueryClient = () => globalThis.queryClient
function isRpcClient(f: any): f is RpcClient<any, any> {
return !!f._isRpcClient
@@ -176,7 +176,7 @@ export function invalidateQuery<TInput, TResult, T extends AsyncFunc>(
// Params not provided, only use first query key item (url)
queryKey = fullQueryKey[0]
}
return queryClient.invalidateQueries(queryKey)
return getQueryClient().invalidateQueries(queryKey)
}
export function setQueryData<TInput, TResult, T extends AsyncFunc>(
@@ -184,15 +184,15 @@ export function setQueryData<TInput, TResult, T extends AsyncFunc>(
params: TInput,
newData: TResult | ((oldData: TResult | undefined) => TResult),
opts: MutateOptions = {refetch: true},
): Promise<void | ReturnType<typeof queryClient.invalidateQueries>> {
): Promise<void | ReturnType<ReturnType<typeof getQueryClient>["invalidateQueries"]>> {
if (typeof resolver === "undefined") {
throw new Error("setQueryData is missing the first argument - it must be a resolver function")
}
const queryKey = getQueryKey(resolver, params)
return new Promise((res) => {
queryClient.setQueryData(queryKey, newData)
let result: void | ReturnType<typeof queryClient.invalidateQueries>
getQueryClient().setQueryData(queryKey, newData)
let result: void | ReturnType<ReturnType<typeof getQueryClient>["invalidateQueries"]>
if (opts.refetch) {
result = invalidateQuery(resolver, params)
}

View File

@@ -3,7 +3,7 @@ import {addBasePath} from "next/dist/shared/lib/router/router"
import {deserialize, serialize} from "superjson"
import {SuperJSONResult} from "superjson/dist/types"
import {CSRFTokenMismatchError, isServer} from "blitz"
import {getQueryKeyFromUrlAndParams, queryClient} from "./react-query-utils"
import {getQueryKeyFromUrlAndParams, getQueryClient} from "./react-query-utils"
import {
getAntiCSRFToken,
getPublicDataStore,
@@ -123,9 +123,9 @@ export function __internal_buildRpcClient({
setTimeout(async () => {
// Do these in the next tick to prevent various bugs like https://github.com/blitz-js/blitz/issues/2207
debug("Invalidating react-query cache...")
await queryClient.cancelQueries()
await queryClient.resetQueries()
queryClient.getMutationCache().clear()
await getQueryClient().cancelQueries()
await getQueryClient().resetQueries()
getQueryClient().getMutationCache().clear()
// We have a 100ms delay here to prevent unnecessary stale queries from running
// This prevents the case where you logout on a page with
// Page.authenticate = {redirectTo: '/login'}
@@ -184,7 +184,7 @@ export function __internal_buildRpcClient({
if (!opts.fromQueryHook) {
const queryKey = getQueryKeyFromUrlAndParams(routePath, params)
queryClient.setQueryData(queryKey, data)
getQueryClient().setQueryData(queryKey, data)
}
return data
}

View File

@@ -4,12 +4,10 @@ import {DefaultOptions, QueryClient} from "react-query"
export * from "./data-client/index"
export const queryClient = globalThis.queryClient
interface BlitzRpcOptions {
reactQueryOptions?: DefaultOptions
}
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, any>(
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, {queryClient: QueryClient}>(
(options?: BlitzRpcOptions) => {
const initializeQueryClient = () => {
const {reactQueryOptions} = options || {}
@@ -37,12 +35,14 @@ export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, any>(
},
})
}
globalThis.queryClient = initializeQueryClient()
const queryClient = initializeQueryClient()
globalThis.queryClient = queryClient
return {
events: {},
middleware: {},
exports: () => {},
exports: () => ({
queryClient,
}),
}
},
)

View File

@@ -3,10 +3,14 @@
*/
import {assert, expect, test, beforeEach, describe, spyOn, it} from "vitest"
import {queryClient, invalidateQuery, setQueryData} from "../../src/data-client"
import {getQueryClient, invalidateQuery, setQueryData} from "../../src/data-client"
import {getQueryCacheFunctions} from "../../src/data-client/react-query-utils"
import {
getQueryCacheFunctions,
initializeQueryClient,
} from "../../src/data-client/react-query-utils"
import {buildQueryRpc} from "../blitz-test-utils"
globalThis.queryClient = initializeQueryClient()
// eslint-disable-next-line require-await
const isEmpty = async (arg: string): Promise<boolean> => {
@@ -14,7 +18,7 @@ const isEmpty = async (arg: string): Promise<boolean> => {
}
describe("getQueryCacheFunctions", () => {
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
beforeEach(() => {
spyRefetchQueries.mockReset()
@@ -47,7 +51,7 @@ describe("getQueryCacheFunctions", () => {
})
describe("invalidateQuery", () => {
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
beforeEach(() => {
spyRefetchQueries.mockReset()
@@ -56,15 +60,15 @@ describe("invalidateQuery", () => {
it("invalidates a query given resolver and params", async () => {
await invalidateQuery(buildQueryRpc(isEmpty), "a")
expect(spyRefetchQueries).toBeCalledTimes(1)
const calledWith = spyRefetchQueries.mock.calls[0][0] as any
const calledWith = spyRefetchQueries.mock.calls[0]![0] as any
// json of the queryKey is "a"
expect(calledWith[1].json).toEqual("a")
})
})
describe("setQueryData", () => {
const spyRefetchQueries = spyOn(queryClient, "invalidateQueries")
const spySetQueryData = spyOn(queryClient, "setQueryData")
const spyRefetchQueries = spyOn(getQueryClient(), "invalidateQueries")
const spySetQueryData = spyOn(getQueryClient(), "setQueryData")
beforeEach(() => {
spyRefetchQueries.mockReset()
@@ -88,7 +92,7 @@ describe("setQueryData", () => {
expect(spyRefetchQueries).toBeCalledTimes(1)
expect(spySetQueryData).toBeCalledTimes(1)
const invalidateCalledWith = spyRefetchQueries.mock.calls[0][0] as any
const invalidateCalledWith = spyRefetchQueries.mock.calls[0]![0] as any
expect(invalidateCalledWith[1].json).toEqual("params")
const calledWith = spySetQueryData.mock.calls[0] as Array<any>

View File

@@ -1,5 +1,33 @@
# blitz
## 2.0.0-alpha.38
### Patch Changes
- Updated dependencies [8aee25c5]
- @blitzjs/generator@2.0.0-alpha.38
## 2.0.0-alpha.37
### Patch Changes
- a80d2a8f: rename middleware type for blitz server plugin
- @blitzjs/generator@2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- Updated dependencies [4cad9cca]
- @blitzjs/generator@2.0.0-alpha.36
## 2.0.0-alpha.35
### Patch Changes
- Updated dependencies [e3750b04]
- @blitzjs/generator@2.0.0-alpha.35
## 2.0.0-alpha.34
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "blitz",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"blitz": "bin/blitz"
},
"dependencies": {
"@blitzjs/generator": "2.0.0-alpha.34",
"@blitzjs/generator": "2.0.0-alpha.38",
"arg": "5.0.1",
"chalk": "^4.1.0",
"console-table-printer": "2.10.0",
@@ -52,7 +52,7 @@
"watchpack": "2.1.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.34",
"@blitzjs/config": "workspace:2.0.0-alpha.38",
"@types/cookie": "0.4.1",
"@types/cross-spawn": "6.0.2",
"@types/debug": "4.1.7",

View File

@@ -22,7 +22,7 @@ export interface MiddlewareResponse<C extends Ctx = Ctx> extends ServerResponse
export type MiddlewareNext = (error?: Error) => Promise<void> | void
export type Middleware<
export type RequestMiddleware<
TRequest extends IncomingMessage = IncomingMessage,
TResponse = ServerResponse,
> = {
@@ -32,11 +32,11 @@ export type Middleware<
}
export type BlitzServerPlugin<
MiddlewareType = Middleware<any, any>,
RequestMiddlewareType = RequestMiddleware<any, any>,
TCtx extends Ctx = Ctx,
TExports extends object = {},
> = {
middlewares: MiddlewareType[]
requestMiddlewares: RequestMiddlewareType[]
contextMiddleware?: (ctx: TCtx) => TCtx
exports?: TExports
}
@@ -54,7 +54,7 @@ export function createServerPlugin<
return pluginConstructor
}
export function createSetupServer<TMiddleware extends Middleware, TExports extends object>(
export function createSetupServer<TMiddleware extends RequestMiddleware, TExports extends object>(
setupServerConstructor: (plugins: BlitzServerPlugin<TMiddleware>) => TExports,
) {
return setupServerConstructor

View File

@@ -1,5 +1,5 @@
import {IncomingMessage, ServerResponse} from "http"
import {compose, Ctx, Middleware, MiddlewareNext, MiddlewareResponse} from "./index-server"
import {compose, Ctx, RequestMiddleware, MiddlewareNext, MiddlewareResponse} from "./index-server"
export async function handleRequestWithMiddleware<
Req extends IncomingMessage = IncomingMessage,
@@ -7,7 +7,7 @@ export async function handleRequestWithMiddleware<
>(
req: Req,
res: Res,
middleware: Middleware<Req, Res>[],
middleware: RequestMiddleware<Req, Res>[],
{
throwOnError = true,
stackPrintOnError = true,
@@ -117,7 +117,7 @@ export async function handleRequestWithMiddleware<
export function noCallbackHandler<
Req extends IncomingMessage = IncomingMessage,
Res = MiddlewareResponse,
>(req: Req, res: Res, next: MiddlewareNext, middleware: Middleware<Req, Res>) {
>(req: Req, res: Res, next: MiddlewareNext, middleware: RequestMiddleware<Req, Res>) {
// Cast to any to call with two arguments for connect compatibility
;(middleware as any)(req, res)
return next()
@@ -131,7 +131,7 @@ export function noCallbackHandler<
export function withCallbackHandler<
Req extends IncomingMessage = IncomingMessage,
Res = MiddlewareResponse,
>(req: Req, res: Res, next: MiddlewareNext, middleware: Middleware<Req, Res>) {
>(req: Req, res: Res, next: MiddlewareNext, middleware: RequestMiddleware<Req, Res>) {
return new Promise((resolve, reject) => {
// Rule doesn't matter since we are inside new Promise()
//eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -150,14 +150,14 @@ export function withCallbackHandler<
export function connectMiddleware<
Req extends IncomingMessage = IncomingMessage,
Res extends MiddlewareResponse = MiddlewareResponse,
>(middleware: Middleware<Req, Res>): Middleware<Req, Res> {
>(middleware: RequestMiddleware<Req, Res>): RequestMiddleware<Req, Res> {
const handler = middleware.length < 3 ? noCallbackHandler : withCallbackHandler
return function connectHandler(req: Req, res, next) {
return handler(req, res, next, middleware)
} as Middleware<Req, Res>
} as RequestMiddleware<Req, Res>
}
export const secureProxyMiddleware: Middleware<
export const secureProxyMiddleware: RequestMiddleware<
IncomingMessage & {protocol?: string},
MiddlewareResponse
> = function (

View File

@@ -1,4 +1,4 @@
import {Middleware} from "./index-server"
import {RequestMiddleware} from "./index-server"
import * as path from "path"
import * as fs from "fs"
@@ -76,7 +76,7 @@ export const setCookie = (name: string, value: string, expires: string) => {
}
export const deleteCookie = (name: string) => setCookie(name, "", "Thu, 01 Jan 1970 00:00:01 GMT")
export function compose(middleware: Middleware<any, any>[]) {
export function compose(middleware: RequestMiddleware<any, any>[]) {
if (!Array.isArray(middleware)) {
throw new TypeError("Middleware stack must be an array!")
}
@@ -115,7 +115,7 @@ export function compose(middleware: Middleware<any, any>[]) {
// return next(result as any)
return dispatch(0).then(next as any)
} as Middleware
} as RequestMiddleware
}
function round(num: number, decimalPlaces: number) {

View File

@@ -1,5 +1,40 @@
# @blitzjs/codemod
## 2.0.0-alpha.38
### Patch Changes
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
- Updated dependencies [8aee25c5]
- @blitzjs/generator@2.0.0-alpha.38
- blitz@2.0.0-alpha.38
## 2.0.0-alpha.37
### Patch Changes
- Updated dependencies [a80d2a8f]
- blitz@2.0.0-alpha.37
- @blitzjs/generator@2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- 4cad9cca: Update queryClient import in codemod
- Updated dependencies [4cad9cca]
- @blitzjs/generator@2.0.0-alpha.36
- blitz@2.0.0-alpha.36
## 2.0.0-alpha.35
### Patch Changes
- e3750b04: codemod fixes
- Updated dependencies [e3750b04]
- @blitzjs/generator@2.0.0-alpha.35
- blitz@2.0.0-alpha.35
## 2.0.0-alpha.34
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/codemod",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
@@ -25,9 +25,9 @@
"@babel/plugin-proposal-class-properties": "7.17.12",
"@babel/plugin-syntax-jsx": "7.17.12",
"@babel/plugin-syntax-typescript": "7.17.12",
"@blitzjs/generator": "2.0.0-alpha.34",
"@blitzjs/generator": "2.0.0-alpha.38",
"arg": "5.0.1",
"blitz": "2.0.0-alpha.34",
"blitz": "2.0.0-alpha.38",
"chalk": "^4.1.0",
"cross-spawn": "7.0.3",
"debug": "4.3.3",

View File

@@ -11,10 +11,13 @@ import {
getAllFiles,
getCollectionFromSource,
wrapDeclaration,
findIdentifier,
} from "./utils"
import {log} from "blitz"
const isInternalBlitzMonorepoDevelopment = fs.existsSync(path.join(__dirname, "../../blitz-next"))
const isInternalBlitzMonorepoDevelopment = fs.existsSync(
path.join(__dirname, "../../../blitz-next"),
)
const upgradeLegacy = async () => {
let isTypescript = fs.existsSync(path.resolve("tsconfig.json"))
@@ -61,7 +64,9 @@ const upgradeLegacy = async () => {
j.assignmentExpression(
"=",
j.memberExpression(j.identifier("module"), j.identifier("exports")),
j.callExpression(j.identifier("withBlitz"), []),
j.callExpression(j.identifier("withBlitz"), [
j.objectExpression([j.objectProperty(j.identifier("blitz"), j.objectExpression([]))]),
]),
),
)
parsedProgram.value.program.body.push(moduleExportExpression)
@@ -129,7 +134,7 @@ const upgradeLegacy = async () => {
GetServerSideProps: "next",
InferGetServerSidePropsType: "next",
GetServerSidePropsContext: "next",
AuthenticatedMiddlewareCtx: "@blitz/rpc",
getAntiCSRFToken: "@blitzjs/rpc",
useSession: "@blitzjs/auth",
useAuthenticatedSession: "@blitzjs/auth",
@@ -261,6 +266,71 @@ const upgradeLegacy = async () => {
},
})
steps.push({
name: "change queryClient to getQueryClient()",
action: async () => {
getAllFiles(appDir, [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach((file) => {
const filepath = path.resolve(appDir, file)
const program = getCollectionFromSource(filepath)
const findQueryClient = () => {
return program.find(j.Identifier, (node) => node.name === "queryClient")
}
findQueryClient().forEach((q) => {
switch (q.name) {
case "imported":
q.value.name = "getQueryClient"
break
case "object":
j(q).replaceWith(j.callExpression(j.identifier("getQueryClient"), []))
break
}
})
fs.writeFileSync(path.resolve(appDir, file), program.toSource())
})
},
})
steps.push({
name: "change BlitzApiRequest to NextApiRequest",
action: async () => {
getAllFiles(path.join(appDir, "api"), [], [], [".ts", ".tsx", ".js", ".jsx"]).forEach(
(file) => {
const program = getCollectionFromSource(file)
findIdentifier(program, "BlitzApiRequest")
.paths()
.forEach((path) => {
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
path.parentPath.parentPath.parentPath.value.source.value = "next"
}
path.value.name = "NextApiRequest"
})
findIdentifier(program, "BlitzApiResponse")
.paths()
.forEach((path) => {
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
path.parentPath.parentPath.parentPath.value.source.value = "next"
}
path.value.name = "NextApiResponse"
})
findIdentifier(program, "BlitzApiHandler")
.paths()
.forEach((path) => {
if (path.parentPath.parentPath.parentPath.value.type === "ImportDeclaration") {
path.parentPath.parentPath.parentPath.value.source.value = "next"
}
path.value.name = "NextApiHandler"
})
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
},
)
},
})
steps.push({
name: "create blitz-server.ts and blitz-client.ts setup files",
action: async () => {
@@ -366,24 +436,66 @@ const upgradeLegacy = async () => {
const getAllPagesDirs = (dirPath: string) => {
let files = fs.readdirSync(dirPath)
const pageDir = files.reduce((arr: {model: string; path: string}[], file: string) => {
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
let subs = fs.readdirSync(dirPath + "/" + file)
if (subs.includes("pages")) {
arr.push({
model: file,
path: dirPath + "/" + file + "/pages",
})
const pageDir = files.reduce(
(arr: {model: string; path: string; subModel?: string}[], file: string) => {
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
let subs = fs.readdirSync(dirPath + "/" + file)
if (subs.includes("pages")) {
// Go a level deeper into "pages"
let subSubs = fs.readdirSync(dirPath + "/" + file + "/pages")
for (let dir of subSubs) {
if (fs.statSync(dirPath + "/" + file + "/pages" + "/" + dir).isDirectory()) {
// If directory structure is like: DIRECTORY/PAGES/DIRECTORY
if (dir === file) {
arr.push({
model: file,
path: dirPath + "/" + file + "/pages" + "/" + dir,
})
} else {
// If there is another directory that doesn't have the same name
arr.push({
model: file,
subModel: dir,
path: dirPath + "/" + file + "/pages" + "/" + dir,
})
}
} else {
arr.push({
model: file,
path: dirPath + "/" + file + "/pages",
})
break
}
}
}
}
}
return arr
}, [])
return arr
},
[],
)
return pageDir
}
getAllPagesDirs(appDir).forEach((pages) => {
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
getAllPagesDirs(appDir).forEach((pages, index) => {
if (pages.subModel) {
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model, pages.subModel))
} else {
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
}
// Delete left over pages directory
let subs = fs.readdirSync(path.join(appDir, pages.model))
// We can only delete a directory once 😅
if (
getAllPagesDirs(appDir)[index - 1]?.model !== getAllPagesDirs(appDir)[index]?.model &&
index === getAllPagesDirs(appDir).length &&
subs.includes("pages")
) {
fs.removeSync(path.join(appDir, pages.model, "pages"))
}
})
},
})
@@ -397,6 +509,8 @@ const upgradeLegacy = async () => {
apiRoutes.forEach((dir) => {
if (fs.statSync(appDir + "/api/" + dir).isDirectory()) {
fs.moveSync(appDir + "/api/" + dir, path.join(path.resolve("pages"), "api", dir))
} else {
fs.moveSync(appDir + "/api/" + dir, path.join(path.resolve("pages"), "api", dir))
}
})
}
@@ -420,11 +534,57 @@ const upgradeLegacy = async () => {
j.Identifier,
(node) => node.name === "blitz" || node.escapedText === "blitz",
)
const findBlitzCustomServerLiteral = program
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
.get()
const findBlitzCustomServerLiteral = program.find(
j.StringLiteral,
(node) => node.value === "blitz/custom-server",
)
findBlitzCustomServerLiteral.value.value = "next"
if (findBlitzCustomServerLiteral.length === 0) {
log.error(
`Failed to find "blitz/custom-server" import in ${customServerDir}/index.${
isTypescript ? "ts" : "js"
}. You will need to update your custom server manually.`,
)
} else {
findBlitzCustomServerLiteral.get().value.value = "next"
findBlitzCall.forEach((hit) => {
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
switch (hit.name) {
case "callee":
hit.value.name = "next"
case "id":
hit.value.name = "next"
case "local":
hit.value.name = "next"
}
})
fs.writeFileSync(
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
program.toSource(),
)
}
}
}
// If custom server file found outside dir
if (fs.existsSync(customServerFile)) {
const program = getCollectionFromSource(customServerFile)
const findBlitzCall = program.find(
j.Identifier,
(node) => node.name === "blitz" || node.escapedText === "blitz",
)
const findBlitzCustomServerLiteral = program.find(
j.StringLiteral,
(node) => node.value === "blitz/custom-server",
)
if (findBlitzCustomServerLiteral.length === 0) {
log.error(
`Failed to find "blitz/custom-server" import in ${customServerFile}. You will need to update your custom server manually.`,
)
} else {
findBlitzCustomServerLiteral.get().value.value = "next"
findBlitzCall.forEach((hit) => {
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
switch (hit.name) {
@@ -436,39 +596,9 @@ const upgradeLegacy = async () => {
hit.value.name = "next"
}
})
fs.writeFileSync(
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
program.toSource(),
)
fs.writeFileSync(customServerFile, program.toSource())
}
}
// If custom server file found outside dir
if (fs.existsSync(customServerFile)) {
const program = getCollectionFromSource(customServerFile)
const findBlitzCall = program.find(
j.Identifier,
(node) => node.name === "blitz" || node.escapedText === "blitz",
)
const findBlitzCustomServerLiteral = program
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
.get()
findBlitzCustomServerLiteral.value.value = "next"
findBlitzCall.forEach((hit) => {
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
switch (hit.name) {
case "callee":
hit.value.name = "next"
case "id":
hit.value.name = "next"
case "local":
hit.value.name = "next"
}
})
fs.writeFileSync(customServerFile, program.toSource())
}
},
})
@@ -717,6 +847,44 @@ const upgradeLegacy = async () => {
},
})
steps.push({
name: "update root types file",
action: async () => {
const typeFile = path.join(process.cwd(), "types.ts")
if (fs.existsSync(typeFile)) {
const program = getCollectionFromSource(typeFile)
const findDefaultCtx = () => {
return program.find(j.Identifier, (node) => node)
}
findDefaultCtx().forEach((path) => {
if (path.value.name === "Ctx") {
path.parentPath.parentPath.value.declaration.extends = []
}
if (path.value.name === "DefaultCtx" && path.name === "imported") {
j(path.parentPath).remove()
}
})
const findBlitzLiteral = () => {
return program.find(j.StringLiteral, (node) => node.value === "blitz")
}
findBlitzLiteral()
.paths()
.forEach((path) => {
path.value.value = "@blitzjs/auth"
})
fs.writeFileSync(typeFile, program.toSource())
} else {
log.error("There is no type file")
}
},
})
steps.push({
name: "check for usages of invokeWithMiddleware",
action: async () => {
@@ -726,7 +894,7 @@ const upgradeLegacy = async () => {
const program = getCollectionFromSource(file)
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
if (invokeWithMiddlewarePath?.length) {
console.error(`invokeWithMiddleware found at ${file}.`)
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
errors++
}
})
@@ -735,14 +903,14 @@ const upgradeLegacy = async () => {
const program = getCollectionFromSource(file)
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
if (invokeWithMiddlewarePath?.length) {
console.error(`invokeWithMiddleware found at ${file}.`)
log.error(`\n invokeWithMiddleware found at ${file}. \n`)
errors++
}
})
if (errors > 0) {
throw new Error(
"invokeWithMiddleware is not supported. Use invokeWithCtx instead: https://canary.blitzjs.com/docs/resolver-server-utilities#invoke-with-ctx",
"\n invokeWithMiddleware is not supported. \n Use invokeWithCtx instead: https://canary.blitzjs.com/docs/resolver-server-utilities#invoke-with-ctx \n Fix the files above, then run the codemod again.",
)
}
},

View File

@@ -9,9 +9,14 @@ import j, {
ImportDeclaration,
CallExpression,
ImportSpecifier,
Identifier,
} from "jscodeshift"
import {parseSync} from "@babel/core"
export function findIdentifier(program: Collection<any>, name: string): Collection<Identifier> {
return program.find(j.Identifier, (node) => node.name === name)
}
export function findFunction(
program: Collection<any>,
declarationName: string,

View File

@@ -1,5 +1,13 @@
# @blitzjs/config
## 2.0.0-alpha.38
## 2.0.0-alpha.37
## 2.0.0-alpha.36
## 2.0.0-alpha.35
## 2.0.0-alpha.34
## 2.0.0-alpha.33

View File

@@ -1,7 +1,7 @@
{
"name": "@blitzjs/config",
"private": true,
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"license": "MIT",
"dependencies": {
"@typescript-eslint/eslint-plugin": "5.9.1",

View File

@@ -1,5 +1,25 @@
# @blitzjs/generator
## 2.0.0-alpha.38
### Patch Changes
- 8aee25c5: getQueryClient function & queryClient codemod updates & shared plugin config
## 2.0.0-alpha.37
## 2.0.0-alpha.36
### Patch Changes
- 4cad9cca: Update codemod and template with a new queryClient import location
## 2.0.0-alpha.35
### Patch Changes
- e3750b04: codemod fixes
## 2.0.0-alpha.34
## 2.0.0-alpha.33

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/generator",
"version": "2.0.0-alpha.34",
"version": "2.0.0-alpha.38",
"scripts": {
"dev": "watch unbuild src --wait=0.2",
"build": "unbuild && pnpm build:templates",
@@ -45,7 +45,7 @@
"vinyl": "2.2.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.34",
"@blitzjs/config": "2.0.0-alpha.38",
"@juanm04/cpx": "2.0.1",
"@types/babel__core": "7.1.19",
"@types/diff": "5.0.2",

View File

@@ -1,5 +1,5 @@
import { NotFoundError, AuthenticationError } from "blitz"
import { db } from "db"
import db from "db"
import { authenticateUser } from "./login"
import { ChangePassword } from "../validations"
import { resolver } from "@blitzjs/rpc"

View File

@@ -1,4 +1,4 @@
import { db } from "db"
import db from "db"
import { hash256 } from "@blitzjs/auth"
import forgotPassword from "./forgotPassword"
import previewEmail from "preview-email"

View File

@@ -1,6 +1,6 @@
import { generateToken, hash256 } from "@blitzjs/auth"
import { resolver } from "@blitzjs/rpc"
import { db } from "db"
import db from "db"
import { forgotPasswordMailer } from "mailers/forgotPasswordMailer"
import { ForgotPassword } from "../validations"

View File

@@ -1,5 +1,5 @@
import resetPassword from "./resetPassword"
import { db } from "db"
import db from "db"
import { SecurePassword, hash256 } from "@blitzjs/auth"
beforeEach(async () => {

View File

@@ -1,5 +1,5 @@
import { SecurePassword, hash256 } from "@blitzjs/auth"
import { db } from "db"
import db from "db"
import { ResetPassword } from "../validations"
import login from "./login"

View File

@@ -1,4 +1,4 @@
import { db } from "db"
import db from "db"
import { SecurePassword } from "@blitzjs/auth"
export default async function signup(input, ctx) {

View File

@@ -2,11 +2,13 @@ import { AuthClientPlugin } from "@blitzjs/auth"
import { setupBlitzClient } from "@blitzjs/next"
import { BlitzRpcPlugin } from "@blitzjs/rpc"
export const authConfig = {
cookiePrefix: "__safeNameSlug__-cookie-prefix"
}
export const { withBlitz } = setupBlitzClient({
plugins: [
AuthClientPlugin({
cookiePrefix: "__safeNameSlug__-cookie-prefix",
}),
AuthClientPlugin(authConfig),
BlitzRpcPlugin({}),
],
})

View File

@@ -1,12 +1,13 @@
import { setupBlitzServer } from "@blitzjs/next"
import { AuthServerPlugin, PrismaStorage } from "@blitzjs/auth"
import {db} from "db"
import db from "db"
import { simpleRolesIsAuthorized } from "@blitzjs/auth"
import { authConfig } from "./blitz-client"
export const { gSSP, gSP, api } = setupBlitzServer({
plugins: [
AuthServerPlugin({
cookiePrefix: "__safeNameSlug__-cookie-prefix",
...authConfig,
storage: PrismaStorage(db as any),
isAuthorized: simpleRolesIsAuthorized,
}),

View File

@@ -1,5 +1,5 @@
import { Ctx } from "blitz"
import { db } from "db"
import db from "db"
export default async function getCurrentUser(_ = null, { session }: Ctx) {
if (!session.userId) return null

View File

@@ -5,4 +5,4 @@ const EnhancedPrisma = enhancePrisma(PrismaClient)
export * from "@prisma/client"
const db = new EnhancedPrisma()
export { db }
export default db

View File

@@ -1,5 +1,5 @@
import {Ctx} from "blitz"
import { db } from "db"
import db from "db"
import {z} from "zod"
if (process.env.parentModel) {

View File

@@ -1,5 +1,5 @@
import {Ctx} from "blitz"
import { db } from "db"
import db from "db"
import {z} from "zod"
const Delete__ModelName__Input = z.object({

View File

@@ -1,4 +1,4 @@
import { db } from "db"
import db from "db"
import {z} from "zod"
const Update__ModelName__Input = z.object({

View File

@@ -1,5 +1,5 @@
import {Ctx, NotFoundError} from "blitz"
import { db } from "db"
import db from "db"
import {z} from "zod"
const Get__ModelName__Input = z.object({

View File

@@ -1,5 +1,5 @@
import {paginate, Ctx} from "blitz"
import { db } from "db"
import db from "db"
import { Prisma } from "@prisma/client"
interface Get__ModelNames__Input

View File

@@ -25,7 +25,7 @@
"@typescript-eslint/parser": "5.9.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.34",
"@blitzjs/config": "2.0.0-alpha.38",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"react": "18.0.0",

521
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff