[Playground] GetMetadata() endpoint

.github/workflows/playground_frontend_test.yml

@@ -86,6 +86,5 @@ jobs:
 
       - name: 'Integration tests'
         run: |
-          cp playground/frontend/lib/config.example.dart playground/frontend/lib/config.g.dart
           chromedriver --port=4444 &
           ./gradlew :playground:frontend:integrationTest -PdeviceId=web-server

learning/tour-of-beam/backend/README.md

@@ -41,6 +41,7 @@ To update mocks for tests, run:
 $ go generate -x ./...
 ```
 
+> Note: [`moq`](https://github.com/matryer/moq) tool to be installed
 
 ### Datastore schema
 

playground/README.md

@@ -80,8 +80,8 @@ cd beam
 
 ### Router, runners, and frontend
 
-1. Edit `/playground/frontend/lib/config.g.dart` to set your local backend host and ports
-found in `/playground/docker-compose.local.yaml`.
+1. Edit `/playground/frontend/playground_components/lib/src/constants/backend_urls.dart`
+to override backend URLs with yours found in `/playground/docker-compose.local.yaml`.
 2. To start, run:
 
 ```bash
@@ -106,6 +106,8 @@ If you do not need particular runners, comment out:
 1. Dependencies on them in `/playground/build.gradle.kts` in `dockerComposeLocalUp` task.
 2. Their Docker image configurations in `/playground/docker-compose.local.yaml`.
 
+See also [Backend Lookup](frontend/README.md#backend-lookup) in the Frontend.
+
 ## Removing old snippets
 
 Run the method to remove unused code snippets from the Cloud Datastore. Unused snippets are snippets that are out of date. If the last visited date property less or equals than the current date minus dayDiff parameter then a snippet is out of date

playground/api/v1/api.proto

@@ -314,6 +314,17 @@ message GetSnippetResponse {
   Complexity complexity = 4;
 }
 
+// GetMetadataRequest represents request for runner metadata
+message GetMetadataRequest {}
+
+// GetMetadataResponse contains metadata about the runner
+message GetMetadataResponse {
+  string runner_sdk = 1;
+  string build_commit_hash = 2;
+  int64 build_commit_timestamp_seconds_since_epoch = 3;
+  string beam_sdk_version = 4;
+}
+
 service PlaygroundService {
 
   // Submit the job for an execution and get the pipeline uuid.
@@ -372,4 +383,7 @@ service PlaygroundService {
 
   // Get the snippet of playground.
   rpc GetSnippet(GetSnippetRequest) returns (GetSnippetResponse);
+
+  // Get the runner metadata.
+  rpc GetMetadata(GetMetadataRequest) returns (GetMetadataResponse);
 }

playground/backend/cmd/server/build_info.go

@@ -0,0 +1,26 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+// This file is intended to store build-time variables.
+// To set a value to any of this variable use '-ldflags="-X main.<variable_name>=<variable_value>"'
+// option when invoking 'go build'.
+
+// BuildCommitHash will contain hash of git commit from which the application is built
+var BuildCommitHash string
+
+// BuildCommitTimestamp will contain timestamp of git commit from which the application is built
+var BuildCommitTimestamp string

playground/backend/cmd/server/controller.go

@@ -15,11 +15,11 @@
 package main
 
 import (
+	"cloud.google.com/go/datastore"
 	"context"
 	"errors"
-
-	"cloud.google.com/go/datastore"
 	"github.com/google/uuid"
+	"strconv"
 
 	pb "beam.apache.org/playground/backend/internal/api/v1"
 	"beam.apache.org/playground/backend/internal/cache"
@@ -529,3 +529,21 @@ func (controller *playgroundController) GetSnippet(ctx context.Context, info *pb
 	}
 	return &response, nil
 }
+
+// GetMetadata returns runner metadata
+func (controller *playgroundController) GetMetadata(_ context.Context, _ *pb.GetMetadataRequest) (*pb.GetMetadataResponse, error) {
+	commitTimestampInteger, err := strconv.ParseInt(BuildCommitTimestamp, 10, 64)
+	if err != nil {
+		logger.Errorf("GetMetadata(): failed to parse BuildCommitTimestamp (\"%s\"): %s", BuildCommitTimestamp, err.Error())
+		commitTimestampInteger = 0
+	}
+
+	response := pb.GetMetadataResponse{
+		RunnerSdk:                             controller.env.BeamSdkEnvs.ApacheBeamSdk.String(),
+		BuildCommitHash:                       BuildCommitHash,
+		BuildCommitTimestampSecondsSinceEpoch: commitTimestampInteger,
+		BeamSdkVersion:                        controller.env.BeamSdkEnvs.BeamVersion,
+	}
+
+	return &response, nil
+}

playground/backend/containers/git-functions.gradle

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * License); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+ext.getGitCommitHash = () -> {
+   def stdout = new ByteArrayOutputStream()
+   exec {
+      executable('git')
+      args('rev-parse', 'HEAD')
+      standardOutput = stdout
+   }
+   return stdout.toString().trim()
+} as Closure<String>
+
+ext.getGitCommitTimestamp = () -> {
+   def stdout = new ByteArrayOutputStream()
+   exec {
+      executable('git')
+      args('show', '-s', '--format=%ct', 'HEAD')
+      standardOutput = stdout
+   }
+   return stdout.toString().trim()
+} as Closure<String>

playground/backend/containers/go/Dockerfile

@@ -20,6 +20,8 @@ ARG BASE_IMAGE
 FROM $BASE_IMAGE
 ARG SDK_TAG
 ARG SDK_TAG_LOCAL
+ARG GIT_COMMIT="<unknown>"
+ARG GIT_TIMESTAMP="0"
 
 # Setup Go Environment
 ENV GOPATH /go
@@ -48,8 +50,9 @@ WORKDIR /go/src/playground/backend
 RUN go mod download &&\
     go mod tidy &&\
     cd cmd/server &&\
-    go build -o /opt/playground/backend/server_go_backend
+    go build -ldflags="-X main.BuildCommitHash=$GIT_COMMIT -X main.BuildCommitTimestamp=$GIT_TIMESTAMP" -o /opt/playground/backend/server_go_backend
 
+ENV BEAM_VERSION=$SDK_TAG
 ENV SERVER_IP=0.0.0.0
 ENV SERVER_PORT=8080
 ENV APP_WORK_DIR=/opt/playground/backend/