Consolidate GRPC samples (#486)

* Add RunnerService examples

* Rename

* Setup instructions

* Consolidate

* Break out setup

* Fix headline

* Return default lifecycle identity if options are nil

* Use json file

* Return default only if unset

* Fix plural

examples/grpc-samples/resolve-vars.json

@@ -0,0 +1,6 @@
+{
+    "script": "export NAME=\"Noname\"\nexport LICENSE=$(cat ../LICENSE)\necho \"LICENSE: $LICENSE\"",
+    "env": [
+        "LICENSE="
+    ]
+}

examples/PROJECTS.md → examples/grpc-samples/services.md

@@ -4,9 +4,9 @@ runme:
   version: v2.2
 ---
 
-## gRPC runme.project.v1.ProjectService
+## ProjectService
 
-Flags matche the launcher arguments in .vscode/launch.json.
+Flags match the launcher arguments in `.vscode/launch.json` for `Debug Server`. Be sure to complete [setup.md](setup.md).
 
 List available operations:
 
@@ -39,3 +39,27 @@ $ grpcurl \
     -d "{\"directory\":{\"path\":\".\"}}" \
     127.0.0.1:9999 runme.project.v1.ProjectService/Load
 ```
+
+## RunnerService
+
+List all runner services.
+
+```sh {"id":"01HNGQNYYWKP635FT8GHE67476","promptEnv":"false"}
+export VERSION="v1" # there's also v2alpha1
+$ grpcurl \
+    -cacert /tmp/runme/tls/cert.pem \
+    -cert /tmp/runme/tls/cert.pem \
+    -key /tmp/runme/tls/key.pem \
+    127.0.0.1:9999 list runme.runner.$VERSION.RunnerService
+```
+
+Resolve variables inside cell:
+
+```sh {"id":"01HNGQS6TV8YKQAKE0ZD7TZREH","promptEnv":"false","terminalRows":"15"}
+$ grpcurl \
+    -cacert /tmp/runme/tls/cert.pem \
+    -cert /tmp/runme/tls/cert.pem \
+    -key /tmp/runme/tls/key.pem \
+    -d @ \
+    127.0.0.1:9999 runme.runner.v1.RunnerService/ResolveVars < resolve-vars.json
+```

examples/grpc-samples/setup.md

@@ -0,0 +1,34 @@
+---
+runme:
+  id: 01HF7BT3HBDTRGQAQMH51RDQEC
+  version: v2.2
+---
+
+# GRPC Setup
+
+Install system dependencies:
+
+```sh {"id":"01HF7BT3HBDTRGQAQMGTJN1KP3"}
+$ brew bundle --no-lock
+```
+
+## Exercise GRPC interface
+
+Issue a simple call to the deserialize API, first set markdown input data:
+
+```sh {"id":"01HF7BT3HBDTRGQAQMH0ZYTWA9"}
+export MD="# Ohai this is my cool headline"
+```
+
+Then issue RPC call and display the result:
+
+```sh {"closeTerminalOnSuccess":"false","id":"01HF7BT3HBDTRGQAQMH2K85BHG","terminalRows":"15"}
+$ data="$(echo $MD | openssl base64 | tr -d '\n')"
+$ cd ../.. && grpcurl \
+    -cacert /tmp/runme/tls/cert.pem \
+    -cert /tmp/runme/tls/cert.pem \
+    -key /tmp/runme/tls/key.pem \
+    -protoset <(buf build -o -) \
+    -d "{\"source\": \"$data\"}" \
+    127.0.0.1:9999 runme.parser.v1.ParserService/Deserialize
+```

internal/document/editor/editorservice/service.go

@@ -26,7 +26,7 @@ func NewParserServiceServer(logger *zap.Logger) parserv1.ParserServiceServer {
 func (s *parserServiceServer) Deserialize(_ context.Context, req *parserv1.DeserializeRequest) (*parserv1.DeserializeResponse, error) {
 	s.logger.Info("Deserialize", zap.ByteString("source", req.Source[:min(len(req.Source), 64)]))
 
-	identityResolver := identity.NewResolver(fromProtoRunmeIdentityToLifecycleIdentity(req.Options.Identity))
+	identityResolver := identity.NewResolver(fromProtoDeserializeReqOptionsToLifecycleIdentity(req.Options))
 	notebook, err := editor.Deserialize(req.Source, identityResolver)
 	if err != nil {
 		s.logger.Info("failed to call Deserialize", zap.Error(err))
@@ -237,15 +237,23 @@ func (*parserServiceServer) serializeCellOutputs(cell *parserv1.Cell, options *p
 	return outputs
 }
 
-func fromProtoRunmeIdentityToLifecycleIdentity(idt parserv1.RunmeIdentity) identity.LifecycleIdentity {
+func fromProtoDeserializeReqOptionsToLifecycleIdentity(opt *parserv1.DeserializeRequestOptions) identity.LifecycleIdentity {
+	var idt parserv1.RunmeIdentity
+
+	if opt != nil {
+		idt = opt.Identity
+	}
+
 	switch idt {
 	case parserv1.RunmeIdentity_RUNME_IDENTITY_ALL:
 		return identity.AllLifecycleIdentity
 	case parserv1.RunmeIdentity_RUNME_IDENTITY_DOCUMENT:
 		return identity.DocumentLifecycleIdentity
 	case parserv1.RunmeIdentity_RUNME_IDENTITY_CELL:
 		return identity.CellLifecycleIdentity
-	default:
+	case parserv1.RunmeIdentity_RUNME_IDENTITY_UNSPECIFIED:
 		return identity.UnspecifiedLifecycleIdentity
+	default:
+		return identity.DefaultLifecycleIdentity
 	}
 }