Netlify http4s handler #89

kubukoz · 2021-12-14T17:39:56Z

Might close #74 in the future.

Instructions for testing:

get netlify-cli (e.g. nix shell nixpkgs#netlify-cli)
run sbt fastOptJS
cp netlify/.js/target/scala-2.13/netlify-fastopt/main.js netlify/functions/example.js (netlify/functions is the default directory for functions)
run netlify functions:serve --debug
send curls to localhost:9999/.netlify/functions/example

build.sbt

lambda/js/src/main/scala/feral/lambda/ContextPlatform.scala

kubukoz · 2021-12-14T17:41:52Z

netlify/src/main/scala/feral/netlify/NetlifyHttp4sHandler.scala

+    for {
+      event <- env.event
+      method <- Method.fromString(event.httpMethod).liftTo[F]
+      uri <- Uri.fromString(event.path).liftTo[F]


Currently this is the relative path. Is that correct or should it be the full URL?

netlify/src/main/scala/feral/netlify/NetlifyHttp4sHandler.scala

netlify/src/main/scala/feral/netlify/NetlifyHttpEvent.scala

netlify/src/main/scala/feral/netlify/handler.scala

build.sbt

netlify-functions/src/main/scala/feral/netlify/facade/Context.scala

netlify-functions/src/main/scala/feral/netlify/LambdaEnv.scala

netlify-functions/src/main/scala/feral/netlify/IOLambda.scala

netlify-functions/src/main/scala/feral/netlify/IOFunction.scala

armanbilge

IIUC, the only kind of netlify function possible is an http handler? In which case, I think we can bake this in much more. E.g.

No need for Event and Result types or Option for the response or implicit decoders/encoders. We can prescribe exactly what these are going to be.
We could even have IOFunction.Simple be implemented directly with an HttpRoutes.

build.sbt

armanbilge · 2021-12-15T16:35:20Z

netlify-functions/src/main/scala/feral/netlify/NetlifyHttp4sHandler.scala

+      event <- env.event
+      method <- Method.fromString(event.httpMethod).liftTo[F]
+      uri <- Uri.fromString(event.path).liftTo[F]
+      headers = Headers(event.headers.toList)


So this problem also applies to the AWS lambda which is admittedly half-baked, do we need to include multiValueHeaders here as well? Also the rawQuery.

probably so, yeah. I'll check and add them

still not done, todo

netlify-functions/src/main/scala/feral/netlify/facade/Context.scala

kubukoz · 2021-12-15T18:29:58Z

IIUC, the only kind of netlify function possible is an http handler? In which case, I think we can bake this in much more.

There's more - you can have functions triggered by deployment events etc. https://docs.netlify.com/functions/trigger-on-events/

technically, it seems like these have the same interface but they have a common body schema, except there's a "background function" type that might not have to return...

armanbilge · 2021-12-15T18:38:25Z

Huh, interesting. As you point out it seems that the http Event/Response are the common shared interface (idk about the background one, but what's the harm in returning a 204 or something lol). Then (a future PR can) add models for those additional triggers and maybe some convenience builders based on them.

Co-Authored-By: Arman Bilge <[email protected]>

Co-authored-by: Arman Bilge <[email protected]>

kubukoz · 2021-12-22T02:00:01Z

lambda/js/src/main/scala/feral/lambda/IOLambdaPlatform.scala

@@ -31,7 +31,7 @@ private[lambda] trait IOLambdaPlatform[Event, Result] {
    js.Dynamic.global.exports.updateDynamic(handlerName)(handlerFn)
  }

-  private lazy val handlerFn
+  protected lazy val handlerFn


todo: fix this after #116 lands

kubukoz · 2021-12-22T02:00:37Z

netlify-functions/src/main/scala/feral/netlify/example.scala

+import cats.effect.IO
+import feral.lambda.Context
+
+object example extends IOFunction.Simple {


to be removed later

Worth moving to examples?

lambda/js/src/main/scala/feral/lambda/ContextPlatform.scala

armanbilge · 2021-12-22T02:04:19Z

lambda/js/src/main/scala/feral/lambda/facade/Context.scala

@@ -17,14 +17,17 @@
 package feral.lambda.facade

 import scala.scalajs.js
+import scala.scalajs.js._


nitpick :P

Suggested change

import scala.scalajs.js._

import scala.scalajs.js.|

armanbilge · 2021-12-22T02:06:47Z

lambda/js/src/main/scala/feral/lambda/ContextPlatform.scala

-      context.memoryLimitInMB.toInt,
+      (context.memoryLimitInMB: Any) match {
+        case s: String => s.toInt
+        case i: Int => i


Hmm, why isn't fatal warnings complaining about this 😆

armanbilge · 2021-12-22T02:08:35Z

netlify-functions/src/main/scala/feral/netlify/HttpFunctionEvent.scala

+import io.circe.Decoder
+import io.circe.Encoder
+
+final case class HttpFunctionEvent(


Let's add a test using this example:
https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

Oh also let's add a KernelSource for this so the tracing middleware works too.

armanbilge · 2021-12-22T02:10:49Z

netlify-functions/src/main/scala/feral/netlify/IOFunction.scala

+
+object IOFunction {
+
+  abstract class Simple extends IOFunction {


Can this extend IOLambda.Simple instead and avoid the repetition?

armanbilge · 2021-12-22T02:12:18Z

netlify-functions/src/main/scala/feral/netlify/example.scala

+import cats.effect.IO
+import feral.lambda.Context
+
+object example extends IOFunction.Simple {


Worth moving to examples?

armanbilge · 2021-12-22T02:33:25Z

lambda/js/src/main/scala/feral/lambda/facade/Context.scala

+  // Note: This should always be a string, but the Netlify CLI currently passes a number.
+  // ref: https://github.com/netlify/functions/pull/251


Upstreamed again to ashiina/lambda-local#218 but I'm not optimistic.

Fixed and released!

armanbilge · 2021-12-22T03:11:29Z

So apparently a netlify Context looks like this:

{
  callbackWaitsForEmptyEventLoop: [Getter/Setter],
  succeed: [Function (anonymous)],
  fail: [Function (anonymous)],
  done: [Function (anonymous)],
  functionVersion: '$LATEST',
  functionName: '164d0769d4ca9c18ce26562dca3f9e408070c2d1c2b884621e91527e1724e77d',
  memoryLimitInMB: '1024',
  logGroupName: '/aws/lambda/164d0769d4ca9c18ce26562dca3f9e408070c2d1c2b884621e91527e1724e77d',
  logStreamName: '2021/08/03/[$LATEST]d3dabe643c01435bb985e7b0ae5821d0',
  clientContext: {
    custom: {
      netlify: 'eyJpZGVudGl0eSI6eyJ1cmwiOiJodHRwczovL2Fkb3JpbmctYWxiYXR0YW5pLWEyODkwNi5uZXRsaWZ5LmFwcC8ubmV0bGlmeS9pZGVudGl0eSIsInRva2VuIjoiZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SmxlSEFpT2pFMk1qYzVOekkxTVRRc0luTjFZaUk2SWpBaWZRLlJGSDVwRDlPUGZUa2lSb3RscXdRekJmbU1JWlF0QWFOVGNkYlVnX2N6WWMifSwidXNlciI6eyJhcHBfbWV0YWRhdGEiOnsicHJvdmlkZXIiOiJlbWFpbCJ9LCJlbWFpbCI6InRlc3RAdGVzdC5jb20iLCJleHAiOjE2Mjc5NzU5NjgsInN1YiI6Ijc3NWE1MzQ0LTBjNmQtNGRjNi05YWM3LWQyZDY0NmUwNzFlYyIsInVzZXJfbWV0YWRhdGEiOnsiZnVsbF9uYW1lIjoiVGVzdCBVc2VyIn19LCJzaXRlX3VybCI6Imh0dHBzOi8vYWRvcmluZy1hbGJhdHRhbmktYTI4OTA2Lm5ldGxpZnkuYXBwIn0='
    },
    identity: {
      url: 'https://adoring-albattani-a28906.netlify.app/.netlify/identity',
      token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2Mjc5NzI1MTQsInN1YiI6IjAifQ.RFH5pD9OPfTkiRotlqwQzBfmMIZQtAaNTcdbUg_czYc'
    },
    user: {
      app_metadata: [Object],
      email: '[email protected]',
      exp: 1627975968,
      sub: '775a5344-0c6d-4dc6-9ac7-d2d646e071ec',
      user_metadata: [Object]
    }
  },
  identity: undefined,
  invokedFunctionArn: 'arn:aws:lambda:us-east-1:375708248955:function:164d0769d4ca9c18ce26562dca3f9e408070c2d1c2b884621e91527e1724e77d',
  awsRequestId: '2ee47065-afe2-433f-b88d-3280e25b5ae4',
  getRemainingTimeInMillis: [Function: getRemainingTimeInMillis]
}

via https://answers.netlify.com/t/could-not-access-user-from-context-inside-netlify-function/41801/6

The bad news is that there does seem to be some custom stuff in ClientContext in addition to the actual custom field being used. So maybe there is some post-processing going on 🤔 . Also, I'm not even sure if those things are "POJSOs" since they rendered as [Object] which suggests it's an instance of a class i.e. not something we can run through circe.

This is really annoying. I don't want to give up all the nice sharing though so I have to think what to do about it.

Edit: here's how they inject it into the lambda-local emulator: https://github.com/netlify/cli/blob/4e6a448bebf556d11e866d2231eb461db5486063/src/lib/functions/server.js#L12

armanbilge · 2021-12-22T23:09:08Z

Some additional notes on clientContext:

custom.netlify will be available via Add support for custom field in ClientContext #117.
The user object is actually just the payload of the JWT carried in the Authorization: Bearer token header. So, we can get at it ourselves without modifying our Context facade.
The identity object, it's not clear to me if we can get at it another way—it would be great to experiment with Netlify and see if we can figure out how it's injected into the request (e.g. a header, environment variable, etc.). Otherwise, I'm inclined to ignore it until somebody complains 😝

kubukoz · 2022-10-05T22:29:27Z

clearly lost interest in this, I'll close for now but anyone can feel free to take whatever they want from this :)

kubukoz commented Dec 14, 2021

View reviewed changes

kubukoz force-pushed the netlify-experiment branch from 2979694 to 02a3609 Compare December 14, 2021 23:07

armanbilge reviewed Dec 14, 2021

View reviewed changes

kubukoz force-pushed the netlify-experiment branch from 02a3609 to 214c957 Compare December 15, 2021 14:57

armanbilge reviewed Dec 15, 2021

View reviewed changes

netlify-functions/src/main/scala/feral/netlify/IOFunction.scala Outdated Show resolved Hide resolved

kubukoz marked this pull request as ready for review December 15, 2021 15:36

armanbilge reviewed Dec 15, 2021

View reviewed changes

kubukoz mentioned this pull request Dec 20, 2021

fix: use number type for memory limit netlify/functions#251

Closed

2 tasks

armanbilge marked this pull request as draft December 21, 2021 18:40

kubukoz and others added 11 commits December 22, 2021 02:13

Add netlify http4s module

5732684

Cleanup build, remove example

5c20d67

Co-Authored-By: Arman Bilge <[email protected]>

Better nulls

d710e97

Co-Authored-By: Arman Bilge <[email protected]>

LambdaEnv -> netlify.FunctionsEnv

0a30a4e

More renames for netlify

f49eb2a

Cleanup imports

5934a13

Hardcode handler name

cb4c1b3

Generate workflows

bb1d9d2

Update build.sbt

7edbec7

Co-authored-by: Arman Bilge <[email protected]>

Support both number and string for memoryLimitInMB

6cab5c7

CI

43de541

kubukoz force-pushed the netlify-experiment branch from 21b7f23 to 43de541 Compare December 22, 2021 01:13

kubukoz added 2 commits December 22, 2021 02:37

Explain union type

1eabf48

Simplify the whole shebang

a1c1030

kubukoz commented Dec 22, 2021

View reviewed changes

armanbilge reviewed Dec 22, 2021

View reviewed changes

armanbilge mentioned this pull request Dec 24, 2021

Use context function for handler in Scala 3? #121

Closed

kubukoz closed this Oct 5, 2022

kubukoz deleted the netlify-experiment branch October 5, 2022 22:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Netlify http4s handler #89

Netlify http4s handler #89

kubukoz commented Dec 14, 2021 •

edited

Loading

kubukoz Dec 14, 2021

armanbilge left a comment

armanbilge Dec 15, 2021

kubukoz Dec 15, 2021

kubukoz Dec 22, 2021

kubukoz commented Dec 15, 2021

armanbilge commented Dec 15, 2021

kubukoz Dec 22, 2021

kubukoz Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge Dec 22, 2021

armanbilge commented Dec 22, 2021 •

edited

Loading

armanbilge commented Dec 22, 2021 •

edited

Loading

kubukoz commented Oct 5, 2022


		object IOFunction {

		abstract class Simple extends IOFunction {

		// Note: This should always be a string, but the Netlify CLI currently passes a number.
		// ref: https://github.com/netlify/functions/pull/251

Netlify http4s handler #89

Netlify http4s handler #89

Conversation

kubukoz commented Dec 14, 2021 • edited Loading

Choose a reason for hiding this comment

armanbilge left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kubukoz commented Dec 15, 2021

armanbilge commented Dec 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armanbilge commented Dec 22, 2021 • edited Loading

armanbilge commented Dec 22, 2021 • edited Loading

kubukoz commented Oct 5, 2022

kubukoz commented Dec 14, 2021 •

edited

Loading

armanbilge commented Dec 22, 2021 •

edited

Loading

armanbilge commented Dec 22, 2021 •

edited

Loading