Migration away from withIronSessionApiRoute

[elie222]

Upgrading from v6 to v8 of this package. What's the easiest way to migrate withIronSessionApiRoute?

[mschilde]

+1 on this. Is there an upgrade guide?

[sacru2red]

in my cases,

export default withIronSessionApiRoute(
  async function handler (
    req: NextApiRequest,
    res: NextApiResponse,
  ) {

 ...
}, IronSessionOptions)

export default async function handler (
    req: NextApiRequest,
    res: NextApiResponse,
) {
    const session = await getIronSession<ApiResonseData>(req, res, IronSessionOptions)
   ...
}

[mattcasey]

Here's the OG source code: https://github.com/vvo/iron-session/blob/v6/next/index.ts

[vvo]

Yep this is how it was done previously:

iron-session/next/index.ts

Lines 19 to 46 in 70d2ff1

	export function withIronSessionApiRoute(
	handler: NextApiHandler,
	options: IronSessionOptions | GetIronSessionApiOptions,
	): NextApiHandler {
	return async function nextApiHandlerWrappedWithIronSession(req, res) {
	let sessionOptions: IronSessionOptions;
	// If options is a function, call it and assign the results back.
	if (options instanceof Function) {
	sessionOptions = await options(req, res);
	} else {
	sessionOptions = options;
	}
	const session = await getIronSession(req, res, sessionOptions);
	// we define req.session as being enumerable (so console.log(req) shows it)
	// and we also want to allow people to do:
	// req.session = { admin: true }; or req.session = {...req.session, admin: true};
	// req.session.save();
	Object.defineProperty(
	req,
	"session",
	getPropertyDescriptorForReqSession(session),
	);
	return handler(req, res);
	};
	}

[ackvf]

In short, instead of

req.session = { admin: true }; // or req.session = {...req.session, admin: true};
req.session.save();

do this

const session = await getIronSession(req, res, sessionOptions)

session = { admin: true }; // or req.session = {...req.session, admin: true};
session.save();