Merge branch 'main' into renovate/charset-normalizer-3.x

CONTRIBUTING.md

@@ -1,34 +1,34 @@
 # How to Contribute
 
-We'd love to accept your patches and contributions to this project. There are
-just a few small guidelines you need to follow.
-
-## Development Principles (for Googlers)
-
-There are a few principles for developing or refactoring the service
-implementations. Read the [Development Principles
-Guide](./docs/development-principles.md).
+Thank you so much for your interest in contributing to Online Boutique.
+Before contributing, you must:
+* Sign the [Contributor License Agreement (CLA)](#contributor-license-agreement).
+* Follow the [Google Open Source Community Guidelines](https://opensource.google.com/conduct/).
+* Follow the [Contribution Process](#contribution-process).
 
 ## Contributor License Agreement
 
-Contributions to this project must be accompanied by a Contributor License
-Agreement. You (or your employer) retain the copyright to your contribution;
-this simply gives us permission to use and redistribute your contributions as
+Contributions to Online Boutique must be accompanied by a Contributor License
+Agreement (CLA). You (or your employer) retain the copyright to your contribution.
+The CLA gives us permission to use and redistribute your contributions as
 part of the project. Head over to <https://cla.developers.google.com/> to see
 your current agreements on file or to sign a new one.
 
 You generally only need to submit a CLA once, so if you've already submitted one
 (even if it was for a different project), you probably don't need to do it
 again.
 
-## Code reviews
+## Contribution Process
 
-All submissions, including submissions by project members, require review. We
-use GitHub pull requests for this purpose. Consult
-[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
-information on using pull requests.
+Here's the process for making a change to this repository:
 
-## Community Guidelines
+1. Review Online Boutique's [purpose](/docs/purpose.md) and [product requirements](/docs/product-requirements.md).
+1. If your proposed changes **do not align** with the purpose and product requirements of Online Boutique, you may be asked to instead maintain your own fork of this repository.
+1. For **small changes** (such as a bug fixes or spelling corrections):
+    1. Fork this repository and submit a [pull request](https://help.github.com/articles/about-pull-requests/).
+    1. Wait for a maintainer of this repository to review your change.
+1. For **bigger changes**:
+    1. Create a [GitHub issue](https://github.com/GoogleCloudPlatform/microservices-demo/issues/new/choose) describing the change **before** working on the implementation. This is important to avoid potentially having to discard your development efforts.
+    1. Wait for a maintainer of this repository to review your GitHub issue. For significantly complex proposals, you may be asked to start a Google Doc to discuss design decisions.
 
-This project follows [Google's Open Source Community
-Guidelines](https://opensource.google.com/conduct/).
+If you have any questions, please [create a GitHub issue](https://github.com/GoogleCloudPlatform/microservices-demo/issues/new/choose).

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-<img src="src/frontend/static/icons/Hipster_HeroLogoCyan.svg" width="300" alt="Online Boutique" />
+<img src="src/frontend/static/icons/Hipster_HeroLogoMaroon.svg" width="300" alt="Online Boutique" />
 </p>
 
 
@@ -138,7 +138,7 @@ The [`/kustomize` folder](kustomize) contains instructions for customizing the d
 ## Architecture
 
 **Online Boutique** is composed of 11 microservices written in different
-languages that talk to each other over gRPC. See the [Development Principles](/docs/development-principles.md) doc for more information.
+languages that talk to each other over gRPC.
 
 [![Architecture of
 microservices](./docs/img/architecture-diagram.png)](./docs/img/architecture-diagram.png)

docs/product-requirements.md

@@ -0,0 +1,39 @@
+## Product Requirements
+
+This document contains a list of requirements that every change made to this repository should meet.
+Every change must:
+1. Preserve the golden user journey taken by Kubernetes beginners.
+1. Preserve the simplicity of demos.
+1. Preserve the simplicity of the GKE quickstart.
+
+These requirements are about the default deployment (default configuration) of Online Boutique.
+Changes that will violate any of these rules should not be built into the default configuration of Online Boutique.
+Such changes should be opt-in only — ideally, as a [Kustomize Component](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/kustomize) if they align with the [purpose of Online Boutique](/docs/purpose.md).
+
+### 1. Preserve the golden user journey taken by Kubernetes beginners
+
+The following statement about Online Boutique should always be true:
+
+> A user outside of Google can deploy Online Boutique's default configuration on a [_kind_ Kubernetes cluster](https://kind.sigs.k8s.io/).
+
+This statement describes the golden user journey that we expect new Kubernetes users to take while onboarding to Online Boutique.
+
+Being able to run Online Boutique on a _kind_ cluster ensures that Online Boutique is free and cloud-agnostic. This is aligned with [Google's mission](https://about.google/) of making information universally accessible and useful. To be specific, Online Boutique should be useful and accessible to developers that are new to Kubernetes.
+
+### 2. Preserve the simplicity of demos
+
+New changes should not complicate the primary user journey showcased in live demos and tutorials.
+
+Today, the primary user journey is as follows:
+1. Visit Online Boutique on a web browser.
+2. Select an item from the homepage and add the item to the cart.
+3. The checkout form is pre-populated with placeholder data (e.g. the shipping address).
+4. The user checks out and completes the order.
+
+### 3. Preserve the simplicity of the GKE quickstart
+
+New changes should not add additional complexity in the [main Online Boutique quickstart](https://github.com/GoogleCloudPlatform/microservices-demo#quickstart-gke).
+
+In particular, new changes should not add extra required steps or additional required tools in that quickstart.
+
+Ideally, extensions to Online Boutique's default functionality (such as a new microservice or a new cloud service integration) should be added as a [Kustomize Component](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/kustomize/components) which users can optionally opt into.

docs/purpose.md

@@ -0,0 +1,15 @@
+## Purpose
+
+Today, the primary purpose of Online Boutique is to demonstrate:
+
+* [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine)
+* [Anthos](https://cloud.google.com/anthos)
+* [Google Cloud Operations](https://cloud.google.com/products/operations)
+* tools and technologies commonly used alongside the above products
+
+while being accessible and useful to all new Kubernetes users.
+
+### Why does the purpose matter?
+
+We filter and prioritize the work to be done in this repository based on the purpose defined above.
+If you wish to make changes to this repository that do not align with the above purpose, we encourage you to maintain your own fork of Online Boutique.

src/adservice/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/adservice/gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

src/adservice/gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%