Skip to content

Commit

Permalink
Sample App: Todolist
Browse files Browse the repository at this point in the history
This changeset adds a new sample app, which ties together all the
features thus far and adds some new ones to facilitate easy app
development. I'm using this sample to help define the underlying
framework structure, when used with Micronaut/Soy.

The sample is built with unified modelling via Protobuf, and RPC
dispatch via gRPC. The UI is built with Soy, with SSR support via
Soy/Java, and re-hydrated CSR support via Soy/JS (and `idom`).

The app's data backend is powered by Firestore, with objects
mediated for serialization by the framework. This process is also
driven by the protos. Auth is also powered by Firebase, which
enables easy data permissions.

Via the central API definition, the app can automatically generate
an API console, docs, and Open API/Swagger configs. It is also
dispatchable from nearly any platform (via either gRPC or REST).
Endpoints served in this manner support either Protobuf on the wire,
or JSON (when using REST).

Styles are defined in SASS but processed by both GSS and PostCSS,
which enables both (1) tight optimization on a per-browser basis,
and (2) style modularity when serving. The server can also rewrite
styles using a Soy/GSS rewrite map.

The sample additionally demonstrates testing, with coverage (where
supported by the framework, so far).

Related and blocking issues:
- [ ] Sample Apps (#26)
- [ ] App Framework (#27)
- [ ] MVP Functionality Matrix (#43)
- [ ] Source-aware Server Targets
- [ ] Modular JS serving, by entrypoint
- [ ] Modular CSS serving, by entrypoint
- [x] Early page render context/frame template
- [x] Basic asset templates/common templates
- [ ] Unable to natively compile complex Soy templates

The following checklist tracks progress towards the above:
- [ ] Data Adapters
  - [ ] Initial adapter: in-memory
  - [ ] First implementation: Firestore
- [ ] RBE/RCE Fixes
  - [x] Remove Python (for now)
  - [ ] Restore Python support w/fix for CI
- [ ] Basic gRPC Support
  - [x] Ability to build/inject/run a gRPC server
  - [ ] Some way to smoothly serve/proxy this
  - [ ] Some plan for Envoy support
  - [ ] TLS vs. ATLS?
  - [ ] Ability to generate a gRPC client
- [ ] Frontend serving logic (more coming soon)
- [ ] Basic *Todolist* app
  - [x] Unified Model: services and objects
    - [x] Object definitions
    - [x] Service definition (`Tasks`)
    - [x] Service configuration
      - [x] Auth (API keys, Firebase auth)
      - [x] Documentation config
      - [x] Quotas and properties
  - [ ] Server-side
    - [ ] `HomeController`: serve anonymous app frame
      - [ ] Basic implementation
      - [ ] Login UI kickoff (via Firebase Auth UI / MDL)
      - [ ] Anonymous app container
    - [ ] `AppController`: serve logged-in app frame
      - [ ] Basic implementation
      - [ ] Logout UI kickoff and handler
    - [ ] Auth/session lifecycle
    - [ ] Rejoiner support
    - [ ] GraphQL schema/support
  - [ ] Web app
    - [ ] gRPC invocation logic
    - [ ] Initial style structure
    - [ ] Java-based app implementation
- [ ] Issues to file
  - [ ] Future: Telemetry
  - [ ] Future: iOS App
  - [ ] Future: Android App
  - [ ] Future: Chrome Extension
  • Loading branch information
sgammon committed Feb 23, 2020
1 parent 4ba341b commit a8337a3
Show file tree
Hide file tree
Showing 68 changed files with 8,644 additions and 564 deletions.
2 changes: 1 addition & 1 deletion .bazelproject
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ workspace_type: java
java_language_level: 11

targets:
//proto/...
//gust/...
//java/...
//js/...
//style/...
Expand Down
3 changes: 2 additions & 1 deletion .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ common --experimental_allow_incremental_repository_updates
build --watchfs
build --symlink_prefix=dist/
build --nolegacy_external_runfiles
build --disk_cache=~/.cache/bazel-disk-cache
build --incompatible_strict_action_env
build --javacopt="-encoding UTF-8"
build --strict_java_deps=strict
Expand Down Expand Up @@ -36,6 +35,7 @@ build:dev --experimental_persistent_javac
build:dev --define=jdk=zulu
build:dev --define=ZULUBASE=/Library/Java/JavaVirtualMachines/zulu-12.jdk/Contents/Home
build:dev --javabase=//defs/toolchain/java:java_runtime
build:dev --disk_cache=~/.cache/bazel-disk-cache

query --output=label_kind

Expand Down Expand Up @@ -83,6 +83,7 @@ build:remote --google_default_credentials=true

test --instrumentation_filter=//...
test --instrument_test_targets
coverage --instrumentation_filter=//...
coverage --instrument_test_targets

try-import %workspace%/.bazelrc.user
Expand Down
2 changes: 1 addition & 1 deletion .bazelversion
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.1
2.1.0
7 changes: 7 additions & 0 deletions .buildkite/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ steps:
- command: "make build CI=yes TARGETS='//samples/rest_mvc/java:MicronautMVCSample-native-bin' && make build CI=yes TARGETS='//samples/soy_ssr/src:MicronautSSRSample-native-bin'"
label: ":java: Build: Native Binaries"
depends_on: framework-build
key: native-build
soft_fail:
- exit_status: 2

- wait

Expand All @@ -22,6 +25,9 @@ steps:

- command: "make build samples CI=yes"
label: ":gcloud: Publish: Images"
depends_on: native-build
soft_fail:
- exit_status: 2

- command: "echo 'registry=https://npm.pkg.github.com/sgammon' > .npmrc && npm publish"
label: ":octocat: + :npm: Staging: NPM"
Expand Down Expand Up @@ -53,4 +59,5 @@ steps:

- command: "make release-images CI=yes"
label: ":docker: Release: Docker"
depends_on: native-build
if: build.tag != null
6 changes: 6 additions & 0 deletions .gcloudignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.git/modules
node_modules/
dist/
build/
vendor/
#!include:.gitignore
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@
[submodule "api_common"]
path = vendor/google/api-common
url = [email protected]:googleapis/api-common-protos.git
[submodule "safe_html_types"]
path = vendor/google/safe-html-types
url = [email protected]:google/safe-html-types.git
4 changes: 2 additions & 2 deletions .ijwb/.bazelproject
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ directories:
external
js
java
proto
gust
tests
jstests
javatests
Expand All @@ -23,7 +23,7 @@ directories:

targets:
//samples/...
//proto/...
//gust/...
//java/...
//js/...
//style/...
Expand Down
203 changes: 203 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed 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.

27 changes: 27 additions & 0 deletions LICENSES/grpc-gateway.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2015, Gengo, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of Gengo, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ COVERAGE_ARGS ?= --function-coverage \
--rc genhtml_hi_limit=90

APP ?=
TARGETS ?= //java/... //proto/... //js/... //style/...
TARGETS ?= //java/... //gust/... //js/... //style/... //jstests/...
TESTS ?= //tests/...
COVERABLE ?= //javatests/... //jstests/...
COVERABLE ?= //javatests:suite

TAG ?=
TEST_ARGS ?= --test_output=errors
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@

## `GUST` [![Build status](https://badge.buildkite.com/7a69b0fadb7d08b691e96177f589971a7646217b1a8b4a269e.svg)](https://buildkite.com/bloombox/gust)
## `@elide-tools/elide` [![Build status](https://badge.buildkite.com/7a69b0fadb7d08b691e96177f589971a7646217b1a8b4a269e.svg)](https://buildkite.com/bloomworks/elide)

** Hello, world! ** I'm a framework.

### Licensing

Below we specify licensing details for the Gust/Elide framework, including pointers to licenses for any dependent software. Gust/Elide itself is licensed under the Apache 2.0 License, which is enclosed in the `LICENSE.txt` file. Licenses for any dependent software (as required/applicable) are embedded in the `LICENSES/` directory, each within their own text file named for the software or framework.

33 changes: 20 additions & 13 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -149,24 +149,31 @@ load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")
stardoc_repositories()

## Python
load("@rules_python//python:repositories.bzl", "py_repositories")
py_repositories()
#load("@rules_python//python:repositories.bzl", "py_repositories")
#py_repositories()

#load("@rules_python//python:pip.bzl", "pip_repositories")
#pip_repositories()

#load("@rules_python//python:pip.bzl", pip_import = "pip3_import")

load("@rules_python//python:pip.bzl", "pip_repositories")
pip_repositories()
#pip_import(
# name = "py",
# requirements = "//defs/toolchain/python:requirements_base.txt")

load("@rules_python//python:pip.bzl", pip_import = "pip3_import")
#pip_import(
# name = "werkzeug",
# requirements = "//defs/toolchain/python:requirements_werkzeug.txt")

pip_import(
name = "py",
requirements = "//defs/toolchain/python:requirements_base.txt")
#load("//defs/toolchain/python:repos.bzl", "gust_python_repositories")
#gust_python_repositories()

pip_import(
name = "werkzeug",
requirements = "//defs/toolchain/python:requirements_werkzeug.txt")
## gRPC Java
load("@io_grpc_java//:repositories.bzl", "grpc_java_repositories")
grpc_java_repositories()

load("//defs/toolchain/python:repos.bzl", "gust_python_repositories")
gust_python_repositories()
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
protobuf_deps()

## Java Containers
load("@io_bazel_rules_docker//container:container.bzl", "container_pull")
Expand Down
Loading

0 comments on commit a8337a3

Please sign in to comment.