Investigate how to test Netlify Edge Functions

[smoya]

Reason/Context

We do have a Netlify Edge Function already in https://github.com/asyncapi/website/tree/master/netlify/edge-functions.
But there are no tests yet. We need to investigate how we can test that, since the runtime is Deno and there are some additions Netlify does on their runtime.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[smoya]

Still relevant

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[smoya]

still relevant

[Maniktherana]

I can pick this up. I'm working on a Netlify function for the newsletter subscriptions so it will fit right in.

[smoya]

I can pick this up. I'm working on a Netlify function for the newsletter subscriptions so it will fit right in.

Awesome! Please feel free to ask any questions or request for help!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[Shurtu-gal]

@smoya found this
Let try it first to see if it works.

[smoya]

@smoya found this
Let try it first to see if it works.

Looks promising! 🙌

[akkshitgupta]

Hey @Shurtu-gal are you working on this issue? If not, I would like to work.

[Shurtu-gal]

Yep still working. Would be glad to receive your opinions too.
Btw @smoya tried the method, turns out it only works for functions not edge ones as they run on Deno runtime.

Have posted this in forum too. I will try to find some new avenues also.

[smoya]

Yep still working. Would be glad to receive your opinions too. Btw @smoya tried the method, turns out it only works for functions not edge ones as they run on Deno runtime.

Have posted this in forum too. I will try to find some new avenues also.

Yeah they run in Deno, I can confirm this to you. But can't we just run the tests on Deno?

About the answer they gave to you:

I believe the only way to test those would be using Netlify CLI. You’d have to start Netlify CLI, use a headless browser like Puppeteer, visit the path with the Edge Functions, and check for expected response.

it will do the job of course, but too overengineered for what we need here. With a simple unit test we are fine.

Anyway, if there is no alternative, we might want to run those tests through any headless browser (like puppeteer does indeed). Not ideal tbh.

[Shurtu-gal]

Yeah, cool will sift through the solutions and would see if can get a Deno test framework up and running. The puppeteer one can be the backup solution if nothing works.

[smoya]

Yeah, cool will sift through the solutions and would see if can get a Deno test framework up and running. The puppeteer one can be the backup solution if nothing works.

Anyway, I think we don't even need deno for that 🤔
Maybe we can just mock the Request and the Context params in a unit test. For the Request, it is an standard Fetch API Request object, and the context could be mocked based on Netlify docs: https://docs.netlify.com/edge-functions/api/. In addition, we would need to mock the fetch API (I think jest already allows you to do so).

Does it make sense? At the end, we want to test if the URL rewrites are done properly without the need of running this as a functional test under a real (headless) browser. The latest could run periodically somewhere but I believe not in CI on each PR because of the overhead.

[Shurtu-gal]

Maybe we can just mock the Request and the Context params in a unit test.

However, this can only work with the deployed Netlify link right?

[smoya]

Maybe we can just mock the Request and the Context params in a unit test.

However, this can only work with the deployed Netlify link right?

If we mock the Fetch API, no real request will be done.
Meaning we could just add some expectations on the calls the code does, like this call to fetch() and also this call to context.next() and match request headers, URL, etc among other checks.

[Shurtu-gal]

Done the work, you can check here :-
The sample PR :- ash17290#1
Workflow in action :- https://github.com/ash17290/website/actions/workflows/netlify-edge-functions-test.yml

If its fine I will make a PR @smoya

[smoya]

Done the work, you can check here :-
The sample PR :- ash17290#1
Workflow in action :- https://github.com/ash17290/website/actions/workflows/netlify-edge-functions-test.yml

If its fine I will make a PR @smoya

Nice! I will check asap. Most probably tomorrow. Hope that works to you.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️