Merge pull request apache#15761 from [BEAM-13008] Create gradle tasks…

… for the Beam Playground

* Implement Beam Playground gradle tasks

* Fix trailing whitespace

* Remove format from precommit

* Fix order of includes and add descriptions

* [BEAM-13008] add generated files and fix analysis issues (#2)

* Reconcile errors with playgroundPrecommit output

Co-authored-by: Aydar Farrakhov <stranniknm@gmail.com>

.gitignore

@@ -113,3 +113,10 @@ website/www/site/code_samples
 website/www/site/_config_branch_repo.toml
 website/www/yarn-error.log
 !website/www/site/content
+
+# Dart/Flutter
+**/.dart_tool
+**/.packages
+**/.flutter-plugins
+**/.flutter-plugins-dependencies
+**/generated_plugin_registrant.dart

build.gradle.kts

@@ -124,9 +124,7 @@ tasks.rat {
     // Ignore Flutter autogenerated files for Playground
     "playground/frontend/.metadata",
     "playground/frontend/pubspec.lock",
-    "playground/frontend/assets/**/*.svg",
-    "playground/frontend/assets/**/*.png",
-    "playground/frontend/assets/**/*.jpg",
+    "playground/frontend/**/*.svg",
 
     // Ignore .gitkeep file
     "**/.gitkeep"
@@ -249,6 +247,15 @@ task("goIntegrationTests") {
   dependsOn(":runners:google-cloud-dataflow-java:worker:shadowJar")
 }
 
+task("playgroundPreCommit") {
+  dependsOn(":playground:backend:tidy")
+  dependsOn(":playground:backend:test")
+
+  dependsOn(":playground:frontend:pubGet")
+  dependsOn(":playground:frontend:analyze")
+  dependsOn(":playground:frontend:test")
+}
+
 task("pythonPreCommit") {
   dependsOn(":sdks:python:test-suites:tox:pycommon:preCommitPyCommon")
   dependsOn(":sdks:python:test-suites:tox:py36:preCommitPy36")

playground/README.md

@@ -0,0 +1,57 @@
+<!--
+    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.
+-->
+
+# Playground
+
+The Beam Playground is a web application to run Beam code snippets in a modern
+browser.  This directory holds code to build, test, and deploy the frontend
+and backend services.
+
+# Requirements
+
+The following requirements are needed for development, testing, and deploying.
+
+- [go 1.16+](https://golang.org)
+- [flutter](https://flutter.dev/)
+- Go protobuf dependencies (See [Go gRPC Quickstart](https://grpc.io/docs/languages/go/quickstart/))
+- Dart protobuf dependencies (See [Dart gRPC Quickstart](https://grpc.io/docs/languages/dart/))
+- [buf](https://docs.buf.build/installation)
+
+# Available Gradle Tasks
+
+## Perform overall pre-commit checks
+
+```
+cd beam
+./gradlew playgroundPrecommit
+```
+
+## To see available gradle tasks for playground:
+
+```
+cd beam
+./gradlew playground:tasks
+```
+
+## Re-generate protobuf
+
+```
+cd beam
+./gradlew playground:generateProto
+```

playground/playground/v1/playground.proto → playground/api/v1/api.proto

@@ -17,9 +17,9 @@
  */
 
 syntax = "proto3";
+option go_package = "beam.apache.org/playground/backend/internal;playground";
 
-option go_package = "github.com/apache/beam/playground/v1;playground";
-package playground.v1;
+package api.v1;
 
 enum Sdk {
   SDK_UNSPECIFIED = 0;
@@ -92,4 +92,4 @@ service PlaygroundService {
 
   // Get the result of pipeline compilation.
   rpc GetCompileOutput(GetCompileOutputRequest) returns (GetCompileOutputResponse);
-}
+}

playground/backend/build.gradle.kts

@@ -0,0 +1,52 @@
+/*
+ * 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.
+ */
+
+description = "Apache Beam :: Playground :: Backend"
+
+task("format") {
+  group = "build"
+  description = "Format backend go code"
+  doLast {
+    exec {
+      executable("gofmt")
+      args("-w", ".")
+    }
+  }
+}
+
+task("tidy") {
+  group = "build"
+  description = "Run go mod tidy"
+  doLast {
+    exec {
+      executable("go")
+      args("mod", "tidy")
+    }
+  }
+}
+
+task("test") {
+  group = "verification"
+  description = "Test the backend"
+  doLast {
+    exec {
+      executable("go")
+      args("test", "internal/...")
+    }
+  }
+}

playground/backend/cmd/server/controller.go

@@ -15,8 +15,9 @@
 package main
 
 import (
-	pb "beam.apache.org/playground/backend/internal/api"
 	"context"
+
+	pb "beam.apache.org/playground/backend/internal/api/v1"
 	"github.com/google/uuid"
 )
 

playground/backend/cmd/server/controller_test.go

@@ -15,7 +15,7 @@
 package main
 
 import (
-	pb "beam.apache.org/playground/backend/internal/api"
+	pb "beam.apache.org/playground/backend/internal/api/v1"
 	"context"
 	"github.com/google/uuid"
 	"google.golang.org/grpc"

playground/backend/cmd/server/server.go

@@ -16,14 +16,15 @@
 package main
 
 import (
-	pb "beam.apache.org/playground/backend/internal/api"
-	"beam.apache.org/playground/backend/internal/environment"
 	"context"
+	"log"
+	"os"
+
+	pb "beam.apache.org/playground/backend/internal/api/v1"
+	"beam.apache.org/playground/backend/internal/environment"
 	"github.com/improbable-eng/grpc-web/go/grpcweb"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/grpclog"
-	"log"
-	"os"
 )
 
 // runServer is starting http server wrapped on grpc
@@ -39,7 +40,7 @@ func runServer() error {
 	handler := Wrap(grpcServer, getGrpcWebOptions())
 	errChan := make(chan error)
 
-	go listenHttp(ctx, errChan, envService.ServerEnvs, handler)
+	go listenHttp(ctx, errChan, envService, handler)
 
 	for {
 		select {