rename

Author: pfandzelter

README.md

@@ -145,7 +145,8 @@ curl --header "X-tinyFaaS-Async: true" "http://localhost:8000/sieve"
 
 #### gRPC
 
-To use the gRPC endpoint, compile the `api` protocol buffer (included in [`./cmd/rproxy/api`](./cmd/rproxy/api)) and import it into your application.
+To use the gRPC endpoint, compile the `tinyfaas` protocol buffer (included in [`./pkg/grpc/tinyfaas`](./pkg/grpc/tinyfaas)) for your programming language and import it into your application.
+We already provide compiled versions for Go and Python in that directory.
 Specify the tinyFaaS host and port (default is `9000`) for the GRPC endpoint and use the `Request` function with the `functionIdentifier` being your function's name and the `data` field including data in any form you want.
 
 ### Removing tinyFaaS

cmd/rproxy/main.go

@@ -9,10 +9,10 @@ import (
 	"os"
 	"strings"
 
+	"github.com/pfandzelter/tinyFaaS/pkg/coap"
+	"github.com/pfandzelter/tinyFaaS/pkg/grpc"
+	tfhttp "github.com/pfandzelter/tinyFaaS/pkg/http"
 	"github.com/pfandzelter/tinyFaaS/pkg/rproxy"
-	"github.com/pfandzelter/tinyFaaS/pkg/tfcoap"
-	"github.com/pfandzelter/tinyFaaS/pkg/tfgrpc"
-	"github.com/pfandzelter/tinyFaaS/pkg/tfhttp"
 )
 
 func main() {
@@ -52,7 +52,7 @@ func main() {
 	// CoAP
 	if listenAddr, ok := listenAddrs["coap"]; ok {
 		log.Printf("starting coap server on %s", listenAddr)
-		go tfcoap.Start(r, listenAddr)
+		go coap.Start(r, listenAddr)
 	}
 	// HTTP
 	if listenAddr, ok := listenAddrs["http"]; ok {
@@ -62,7 +62,7 @@ func main() {
 	// GRPC
 	if listenAddr, ok := listenAddrs["grpc"]; ok {
 		log.Printf("starting grpc server on %s", listenAddr)
-		go tfgrpc.Start(r, listenAddr)
+		go grpc.Start(r, listenAddr)
 	}
 
 	server := http.NewServeMux()

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/google/uuid v1.3.0
 	github.com/pfandzelter/go-coap v0.1.0
 	google.golang.org/grpc v1.53.0
-	google.golang.org/protobuf v1.29.1
+	google.golang.org/protobuf v1.31.0
 )
 
 require (

go.sum

@@ -3,9 +3,12 @@ github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 h1:UQHMgLO+TxOEl
 github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migciow=
 github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM=
 github.com/Microsoft/hcsshim v0.10.0-rc.8 h1:YSZVvlIIDD1UxQpJp0h+dnpLUw+TrY0cx8obKsp3bek=
+github.com/checkpoint-restore/go-criu/v5 v5.3.0/go.mod h1:E/eQpaFtUKGOOSEBZgmKAcn+zUUwWxqcaKZlF54wK8E=
+github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkXar0TQ1gf3U=
 github.com/containerd/containerd v1.7.2 h1:UF2gdONnxO8I6byZXDi5sXWiWvlW3D/sci7dTQimEJo=
 github.com/containerd/containerd v1.7.2/go.mod h1:afcz74+K10M/+cjGHIVQrCt3RAQhUSCAjJ9iMYhhkuI=
 github.com/cyphar/filepath-securejoin v0.2.3 h1:YX6ebbZCZP7VkM3scTTokDgBL2TY741X51MTk3ycuNI=
+github.com/cyphar/filepath-securejoin v0.2.3/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -38,6 +41,7 @@ github.com/moby/term v0.5.0 h1:xt8Q1nalod/v7BqbG21f8mQPqH+xAaC9C3N3wfWbVP0=
 github.com/moby/term v0.5.0/go.mod h1:8FzsFHVUBGZdbDsJw/ot+X+d5HLUbvklYLJ9uGfcI3Y=
 github.com/morikuni/aec v1.0.0 h1:nP9CBfwrvYnBRgY6qfDQkygYDmYwOilePFkwzv4dU8A=
 github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc=
+github.com/mrunalp/fileutils v0.5.0/go.mod h1:M1WthSahJixYnrXQl/DFQuteStB1weuxD2QJNHXfbSQ=
 github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
 github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
 github.com/opencontainers/image-spec v1.1.0-rc2.0.20221005185240-3a7f492d3f1b h1:YWuSjZCQAPM8UUBLkYUk1e+rZcvWHJmFb6i6rM44Xs8=
@@ -50,11 +54,14 @@ github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/seccomp/libseccomp-golang v0.9.2-0.20220502022130-f33da4d89646/go.mod h1:JA8cRccbGaA1s33RQf7Y1+q9gHmZX1yB/z9WDN1C6fg=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
 github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
 github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/syndtr/gocapability v0.0.0-20200815063812-42c35b437635/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
@@ -106,6 +113,8 @@ google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp0
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 google.golang.org/protobuf v1.29.1 h1:7QBf+IK2gx70Ap/hDsOmam3GE0v9HicjfEdAxE62UoM=
 google.golang.org/protobuf v1.29.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
+google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

pkg/tfcoap/tfcoap.go renamed to pkg/coap/coap.go

@@ -1,4 +1,4 @@
-package tfcoap
+package coap
 
 import (
 	"log"

pkg/tfdocker/handler.go renamed to pkg/docker/handler.go

@@ -1,4 +1,4 @@
-package tfdocker
+package docker
 
 import (
 	"bufio"

pkg/tfgrpc/tfgrpc.go renamed to pkg/grpc/grpc.go

@@ -1,13 +1,13 @@
-package tfgrpc
+package grpc
 
 import (
 	"context"
 	"fmt"
 	"log"
 	"net"
 
+	"github.com/pfandzelter/tinyFaaS/pkg/grpc/tinyfaas"
 	"github.com/pfandzelter/tinyFaaS/pkg/rproxy"
-	"github.com/pfandzelter/tinyFaaS/pkg/tfgrpc/api"
 	"google.golang.org/grpc"
 )
 
@@ -17,33 +17,33 @@ type GRPCServer struct {
 }
 
 // Request handles a request to the GRPC endpoint of the reverse-proxy of this tinyFaaS instance.
-func (gs *GRPCServer) Request(ctx context.Context, d *api.Data) (*api.Response, error) {
+func (gs *GRPCServer) Request(ctx context.Context, d *tinyfaas.Data) (*tinyfaas.Response, error) {
 
 	log.Printf("have request for path: %s (async: %v)", d.FunctionIdentifier, false)
 
 	s, res := gs.r.Call(d.FunctionIdentifier, []byte(d.Data), false)
 
 	switch s {
 	case rproxy.StatusOK:
-		return &api.Response{
+		return &tinyfaas.Response{
 			Response: string(res),
 		}, nil
 	case rproxy.StatusAccepted:
-		return &api.Response{}, nil
+		return &tinyfaas.Response{}, nil
 	case rproxy.StatusNotFound:
 		return nil, fmt.Errorf("function %s not found", d.FunctionIdentifier)
 	case rproxy.StatusError:
 		return nil, fmt.Errorf("error calling function %s", d.FunctionIdentifier)
 	}
-	return &api.Response{
+	return &tinyfaas.Response{
 		Response: string(res),
 	}, nil
 }
 
 func Start(r *rproxy.RProxy, listenAddr string) {
 	gs := grpc.NewServer()
 
-	api.RegisterTinyFaaSServer(gs, &GRPCServer{
+	tinyfaas.RegisterTinyFaaSServer(gs, &GRPCServer{
 		r: r,
 	})
 

pkg/grpc/tinyfaas/Makefile

@@ -0,0 +1,18 @@
+.PHONY: all
+
+PROTO = tinyfaas
+
+all: ${PROTO}_pb2.py ${PROTO}_pb2.pyi ${PROTO}_pb2_grpc.py ${PROTO}.pb.go ${PROTO}_grpc.pb.go
+
+# requires protoc,  protoc-gen-go and protoc-gen-go-grpc
+# install from your package manager, e.g.:
+# 	brew install protobuf
+# 	brew install protoc-gen-go
+#	brew install protoc-gen-go-grpc
+${PROTO}.pb.go ${PROTO}_grpc.pb.go: ${PROTO}.proto
+	@protoc -I . $< --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false,paths=source_relative
+
+# requires grpcio-tools and mypy-protobuf
+# 	python3 -m pip install -r requirements.txt
+${PROTO}_pb2.py ${PROTO}_pb2.pyi ${PROTO}_pb2_grpc.py: ${PROTO}.proto
+	@python3 -m grpc_tools.protoc -I . --python_out=. --grpc_python_out=. --mypy_out=. $<

pkg/grpc/tinyfaas/requirements.txt

@@ -0,0 +1,4 @@
+grpcio==1.56.0
+grpcio-tools==1.56.0
+protobuf==4.23.3
+mypy-protobuf==3.4.0