fix: set projectId to a default value in emulator case #1345

dmivankov · 2021-08-12T11:40:15Z

Spanner client wants to have a projectId option set, by default it also tries to pick it up from lots of places
For emulator case none of those may be present as it could be that neither gcloud nor default application credentials are configured, but emulator is accessible nevertheless.

Set default project id in SpannerOptions, value doesn't matter so much as emulator would be happy with any value it seems.
Note that alternatively it could be improved in base ServiceOptions, but not sure about assumptions there.

failure example in case where emulatorHost is set without projectId

  java.lang.IllegalArgumentException: A project ID is required for this service but could not be determined from the builder or the environment.  Please set a project ID using the builder.
  at com.google.common.base.Preconditions.checkArgument(Preconditions.java:142)
  at com.google.cloud.ServiceOptions.<init>(ServiceOptions.java:304)
  at com.google.cloud.spanner.SpannerOptions.<init>(SpannerOptions.java:533)
  at com.google.cloud.spanner.SpannerOptions.<init>(SpannerOptions.java:77)
  at com.google.cloud.spanner.SpannerOptions$Builder.build(SpannerOptions.java:1029)

Note that in non-emulator case one usually doesn't need to set projectId as it could be extracted from credentials

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> ☕️

Spanner client wants to have a projectId option set, by default it also tries to pick it up from [lots of places](https://github.com/googleapis/java-core/blob/375983090b3700b3fb6a1953626db7efca49cc51/google-cloud-core/src/main/java/com/google/cloud/ServiceOptions.java#L372) For emulator case none of those may be present as it could be that neither gcloud nor default application credentials are configured, but emulator is accessible nevertheless. Set default project id in SpannerOptions, value doesn't matter so much as emulator would be happy with any value it seems. Note that alternatively it could be improved in base ServiceOptions, but not sure about assumptions there.

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

…annerOptions.java

olavloite

Hi @dmivankov Thanks for your contribution. I think this is a good idea. I've left a couple of textual suggestions.
Also, there seems to be a compile error. Would you mind take a look at that?

Also, would you be able to add a test that verifies that it will actually use this, and that it does not fail before it gets this far? If not, then that's OK as well. I can take a look at a later moment. It might be quite tricky as such a test would depend on a lot of different environment variables.

@thiagotnunes Do you have any additional comments on this?

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

thiagotnunes

There is a compilation error, but LGTM.

After fixing that we should be good to go.

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

…annerOptions.java

dmivankov · 2021-08-13T11:01:10Z

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

@@ -1134,6 +1134,11 @@ public SpannerOptions build() {
        this.setChannelConfigurator(ManagedChannelBuilder::usePlaintext);
        // As we are using plain text, we should never send any credentials.
        this.setCredentials(NoCredentials.getInstance());
+        // Default project id resolution might fail, but the emulator accepts any
+        // project id, so we can safely use a dummy id.
+        if (this.getProjectId() == null) {


oops, may need more work as there's no such getter in ServiceOptions builder and the field is private https://github.com/googleapis/java-core/blob/375983090b3700b3fb6a1953626db7efca49cc51/google-cloud-core/src/main/java/com/google/cloud/ServiceOptions.java#L127

Use a dummy emulator-project when no default project is set for the environment and the SPANNER_EMULATOR_HOST environment variable has been set. Replaces #1345

olavloite · 2021-08-19T13:51:15Z

@dmivankov I've created a new PR that uses a slightly different approach to achieve the same goal: #1363

Use a dummy emulator-project when no default project is set for the environment and the SPANNER_EMULATOR_HOST environment variable has been set. Replaces #1345

thiagotnunes · 2021-08-19T23:24:19Z

Closed in favour of #1363

🤖 I have created a release \*beep\* \*boop\* --- ## [6.12.0](https://www.github.com/googleapis/java-spanner/compare/v6.11.1...v6.12.0) (2021-08-24) ### Features * add support for JSON data type ([#872](https://www.github.com/googleapis/java-spanner/issues/872)) ([d7ff940](https://www.github.com/googleapis/java-spanner/commit/d7ff9409e974602dc9b18f82d6dbd11d96c956bf)) * use dummy emulator-project when no project is set ([#1363](https://www.github.com/googleapis/java-spanner/issues/1363)) ([673855e](https://www.github.com/googleapis/java-spanner/commit/673855eea8c244457ad4c8ac5abe3ad3a0a0cdde)), closes [#1345](https://www.github.com/googleapis/java-spanner/issues/1345) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

dmivankov requested a review from a team as a code owner August 12, 2021 11:40

product-auto-label bot added the api: spanner Issues related to the googleapis/java-spanner API. label Aug 12, 2021

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Aug 12, 2021

dmivankov commented Aug 12, 2021

View reviewed changes

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java Outdated Show resolved Hide resolved

Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…

9740d9e

…annerOptions.java

dmivankov changed the title ~~Set projectId to a default value in emulator case~~ fix: set projectId to a default value in emulator case Aug 12, 2021

olavloite reviewed Aug 12, 2021

View reviewed changes

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java Outdated Show resolved Hide resolved

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java Outdated Show resolved Hide resolved

thiagotnunes and others added 2 commits August 13, 2021 14:46

docs: update comment for emulator default project

9edd63e

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

fix: set emulator project id

ba4ea34

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

thiagotnunes approved these changes Aug 13, 2021

View reviewed changes

dmivankov commented Aug 13, 2021

View reviewed changes

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java Outdated Show resolved Hide resolved

Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…

f28dddb

…annerOptions.java

dmivankov commented Aug 13, 2021

View reviewed changes

olavloite mentioned this pull request Aug 19, 2021

feat: use dummy emulator-project when no project is set #1363

Merged

thiagotnunes closed this Aug 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: set projectId to a default value in emulator case #1345

fix: set projectId to a default value in emulator case #1345

dmivankov commented Aug 12, 2021 •

edited

Loading

olavloite left a comment •

edited

Loading

thiagotnunes left a comment •

edited

Loading

dmivankov Aug 13, 2021

olavloite commented Aug 19, 2021

thiagotnunes commented Aug 19, 2021 •

edited

Loading

fix: set projectId to a default value in emulator case #1345

fix: set projectId to a default value in emulator case #1345

Conversation

dmivankov commented Aug 12, 2021 • edited Loading

olavloite left a comment • edited Loading

Choose a reason for hiding this comment

thiagotnunes left a comment • edited Loading

Choose a reason for hiding this comment

dmivankov Aug 13, 2021

Choose a reason for hiding this comment

olavloite commented Aug 19, 2021

thiagotnunes commented Aug 19, 2021 • edited Loading

dmivankov commented Aug 12, 2021 •

edited

Loading

olavloite left a comment •

edited

Loading

thiagotnunes left a comment •

edited

Loading

thiagotnunes commented Aug 19, 2021 •

edited

Loading