chore(cloud/shelf): split package#231
Draft
brianquinlan wants to merge 1 commit intogoogleapis:mainfrom
Draft
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors the project by extracting shelf-related HTTP serving functionality from package:google_cloud into a new standalone package, package:shelf_google_cloud. The changes include moving source code, tests, and documentation, as well as updating the workspace configuration. Feedback was provided regarding the duplication of constants in the new package that are already available in the core google_cloud package, suggesting they should be reused to maintain consistency and reduce synchronization risks.
Comment on lines
+1
to
+86
| // Copyright 2022 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| /// The standard environment variable for specifying the port a service should | ||
| /// listen on. | ||
| const portEnvironmentVariable = 'PORT'; | ||
|
|
||
| /// Standard environment variable for specifying the path to a service account | ||
| /// JSON file. | ||
| /// | ||
| /// See: https://docs.cloud.google.com/docs/authentication/application-default-credentials | ||
| const credentialsPathEnvironmentVariable = 'GOOGLE_APPLICATION_CREDENTIALS'; | ||
|
|
||
| /// A set of standard environment variables that are likely to represent the | ||
| /// current Google Cloud project ID. | ||
| /// | ||
| /// For context, see: | ||
| /// * https://github.com/googleapis/google-auth-library-nodejs/blob/main/src/auth/googleauth.ts | ||
| /// * https://cloud.google.com/functions/docs/env-var | ||
| /// | ||
| /// Note: these are ordered starting from the most current/canonical to least. | ||
| /// (At least as could be determined at the time of writing.) | ||
| const projectIdEnvironmentVariableOptions = { | ||
| projectIdEnvironmentVariable, | ||
| 'GCP_PROJECT', | ||
| 'GCLOUD_PROJECT', | ||
| 'CLOUDSDK_CORE_PROJECT', | ||
| }; | ||
|
|
||
| /// The standard environment variable for specifying the Google Cloud project | ||
| /// ID. | ||
| const projectIdEnvironmentVariable = 'GOOGLE_CLOUD_PROJECT'; | ||
|
|
||
| /// The default port a service should listen on if [portEnvironmentVariable] is | ||
| /// not set. | ||
| const defaultListenPort = 8080; | ||
|
|
||
| /// Standard HTTP header used by | ||
| /// [Cloud Trace](https://cloud.google.com/trace/docs/setup). | ||
| const cloudTraceContextHeader = 'x-cloud-trace-context'; | ||
|
|
||
| /// Standard HTTP request headers expected by the | ||
| /// [Metadata Server](https://cloud.google.com/compute/docs/metadata). | ||
| const metadataFlavorHeaders = {'Metadata-Flavor': 'Google'}; | ||
|
|
||
| /// The name of the Cloud Run service being run. | ||
| /// | ||
| /// See https://docs.cloud.google.com/run/docs/container-contract#services-env-vars | ||
| const serviceEnvironmentVariable = 'K_SERVICE'; | ||
|
|
||
| /// The name of the Cloud Run revision being run. | ||
| /// | ||
| /// See https://docs.cloud.google.com/run/docs/container-contract#services-env-vars | ||
| const revisionEnvironmentVariable = 'K_REVISION'; | ||
|
|
||
| /// The name of the Cloud Run configuration being run. | ||
| /// | ||
| /// See https://docs.cloud.google.com/run/docs/container-contract#services-env-vars | ||
| const configurationEnvironmentVariable = 'K_CONFIGURATION'; | ||
|
|
||
| /// The `payload` key used to correlate log entries with Cloud Trace. | ||
| /// | ||
| /// See https://docs.cloud.google.com/logging/docs/agent/logging/configuration#special-fields | ||
| const logTraceKey = 'logging.googleapis.com/trace'; | ||
|
|
||
| /// The `payload` key used to correlate log entries with a specific span within | ||
| /// a Cloud Trace. | ||
| /// | ||
| /// See https://docs.cloud.google.com/logging/docs/agent/logging/configuration#special-fields | ||
| const logSpanIdKey = 'logging.googleapis.com/spanId'; | ||
|
|
||
| /// The `payload` key used to indicate whether a trace is sampled. | ||
| /// | ||
| /// See https://docs.cloud.google.com/logging/docs/agent/logging/configuration#special-fields | ||
| const logTraceSampledKey = 'logging.googleapis.com/trace_sampled'; |
Contributor
There was a problem hiding this comment.
This file duplicates constants that are already defined in package:google_cloud/constants.dart. Since shelf_google_cloud depends on google_cloud, it should reuse the existing constants to ensure consistency and simplify maintenance. Redefining them here creates a synchronization risk if the standard GCP environment variables or logging keys ever change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.