Skip to content

feat(proxy): support onResponse callback #368

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.

Sign up for GitHub

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

Merged
pi0 merged 2 commits into from
Jun 20, 2023
Merged

feat(proxy): support onResponse callback #368

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17c3ff3
feat: add onResponse callback to sendProxy
enkot Mar 29, 2023
e0dfee4
feat: adds response as second argument
enkot Apr 29, 2023
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
5 changes: 5 additions & 0 deletions src/utils/proxy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export interface ProxyOptions {
sendStream?: boolean;
cookieDomainRewrite?: string | Record<string, string>;
cookiePathRewrite?: string | Record<string, string>;
onResponse?: (event: H3Event) => void;
}

const PayloadMethods = new Set(["PATCH", "POST", "PUT", "DELETE"]);
Expand Down Expand Up @@ -105,6 +106,10 @@ export async function sendProxy(
event.node.res.setHeader(key, value);
}

if (opts.onResponse) {
await opts.onResponse(event);
Copy link
Copy Markdown
Member

@pi0 pi0 Apr 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be also nice to pass over the actual response as second argument

Copy link
Copy Markdown
Contributor Author

@enkot enkot Apr 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, done!

}

// Directly send consumed _data
if ((response as any)._data !== undefined) {
return (response as any)._data;
Expand Down
49 changes: 49 additions & 0 deletions test/proxy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,4 +341,53 @@ describe("", () => {
);
});
});

describe("onResponse", () => {
beforeEach(() => {
app.use(
"/debug",
eventHandler(() => {
return {};
})
);
});

it("allows modifying response event", async () => {
app.use(
"/",
eventHandler((event) => {
return proxyRequest(event, url + "/debug", {
fetch,
onResponse(_event) {
setHeader(_event, "x-custom", "hello");
},
});
})
);

const result = await request.get("/");

expect(result.header["x-custom"]).toEqual("hello");
});

it("allows modifying response event async", async () => {
app.use(
"/",
eventHandler((event) => {
return proxyRequest(event, url + "/debug", {
fetch,
onResponse(_event) {
return new Promise((resolve) => {
resolve(setHeader(_event, "x-custom", "hello"));
});
},
});
})
);

const result = await request.get("/");

expect(result.header["x-custom"]).toEqual("hello");
});
});
});