Skip to content

Commit d26ecb8

Browse files
danieljbrucedanieljbruce
authored
fix: Use the universe domain if it is provided by the user (#1563)
**Summary:** The user should be able to set the universe domain so that outgoing calls work with a different Google Cloud Universe. Right now, if the user specifies a universe domain then it will not get used and the request will just be sent to the default Bigtable endpoint. **Changes:** `src/index.ts:` The change here is that when a custom url is not provided, but a universe domain is provided then the servicePath will use the universe domain provided. This is done for each Gapic client and ensures requests will be made to the universe domain instead of the default Bigtable service. `system-test/service-path.ts`: Two tests are added to ensure the service path is always set correctly. For instance, when a custom endpoint is provided then the service path will still always be that custom endpoint. When a custom endpoint is NOT provided, but a universe domain is provided then the service path is set to use the universe domain instead of the default endpoint. **Alternatives:** 1. Instead of requiring the user to set the universe domain for each Gapic client, we could expose a `universeDomain` option that would apply to all clients. While this would make things easier for users, it is an API change so it is not reversible. For now we should not change the API since users already have a way to specify the universe domains for the Gapic clients. We can always add this option later. 2. When a custom endpoint is not provided then in the handwritten layer we could not provide a service path. The Pros of this option is that we can rely on the code in the Gapic layer for building the service path instead of creating the getDomain function introducing duplicate code and this would reduce technical debt. The main problem with this option is that it means [providedCustomServicePath](https://togithub.com/googleapis/nodejs-bigtable/blob/2fdf98f9398761046f41bd58e00258f0d4963a3d/src/v2/bigtable_client.ts#L132) will now be undefined and this value is used in the grpc stub so we don't know how such a change might affect the outgoing API calls. The code to implement this alternative also gets messy if Alternative 1 isn't adopted as well.
1 parent d295afa commit d26ecb8

File tree

2 files changed

+236
-6
lines changed

2 files changed

+236
-6
lines changed

‎src/index.ts‎

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,31 @@ export interface BigtableOptions extends gax.GoogleAuthOptions {
102102
BigtableTableAdminClient?: gax.ClientOptions;
103103
}
104104

105+
/**
106+
* Retrieves the domain to be used for the service path.
107+
*
108+
* This function retrieves the domain from gax.ClientOptions passed in or via an environment variable.
109+
* It defaults to 'googleapis.com' if none has been set.
110+
* @param {string} [prefix] The prefix for the domain.
111+
* @param {gax.ClientOptions} [opts] The gax client options
112+
* @returns {string} The universe domain.
113+
*/
114+
function getDomain(prefix: string, opts?: gax.ClientOptions) {
115+
// From https://github.com/googleapis/nodejs-bigtable/blob/589540475b0b2a055018a1cb6e475800fdd46a37/src/v2/bigtable_client.ts#L120-L128.
116+
// This code for universe domain was taken from the Gapic Layer.
117+
// It is reused here to build the service path.
118+
const universeDomainEnvVar =
119+
typeof process === 'object' && typeof process.env === 'object'
120+
? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
121+
: undefined;
122+
return `${prefix}.${
123+
opts?.universeDomain ??
124+
opts?.universe_domain ??
125+
universeDomainEnvVar ??
126+
'googleapis.com'
127+
}`;
128+
}
129+
105130
/**
106131
* @typedef {object} ClientConfig
107132
* @property {string} [apiEndpoint] Override the default API endpoint used
@@ -413,9 +438,6 @@ export class Bigtable {
413438
}
414439
}
415440

416-
const defaultBaseUrl = 'bigtable.googleapis.com';
417-
const defaultAdminBaseUrl = 'bigtableadmin.googleapis.com';
418-
419441
const customEndpoint =
420442
options.apiEndpoint || process.env.BIGTABLE_EMULATOR_HOST;
421443
this.customEndpoint = customEndpoint;
@@ -445,7 +467,9 @@ export class Bigtable {
445467
{},
446468
baseOptions,
447469
{
448-
servicePath: customEndpointBaseUrl || defaultBaseUrl,
470+
servicePath:
471+
customEndpointBaseUrl ||
472+
getDomain('bigtable', options.BigtableClient),
449473
'grpc.callInvocationTransformer': grpcGcp.gcpCallInvocationTransformer,
450474
'grpc.channelFactoryOverride': grpcGcp.gcpChannelFactoryOverride,
451475
'grpc.gcpApiConfig': grpcGcp.createGcpApiConfig({
@@ -464,14 +488,26 @@ export class Bigtable {
464488
{},
465489
baseOptions,
466490
{
467-
servicePath: customEndpointBaseUrl || defaultAdminBaseUrl,
491+
servicePath:
492+
customEndpointBaseUrl ||
493+
getDomain('bigtableadmin', options.BigtableClient),
494+
},
495+
options
496+
);
497+
const instanceAdminOptions = Object.assign(
498+
{},
499+
baseOptions,
500+
{
501+
servicePath:
502+
customEndpointBaseUrl ||
503+
getDomain('bigtableadmin', options.BigtableClient),
468504
},
469505
options
470506
);
471507

472508
this.options = {
473509
BigtableClient: dataOptions,
474-
BigtableInstanceAdminClient: adminOptions,
510+
BigtableInstanceAdminClient: instanceAdminOptions,
475511
BigtableTableAdminClient: adminOptions,
476512
};
477513

‎system-test/service-path.ts‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
// Copyright 2025 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// https://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
import {describe, it} from 'mocha';
16+
import * as assert from 'assert';
17+
import {ServiceError} from 'google-gax';
18+
import {Bigtable} from '../src';
19+
import {BigtableClient, BigtableInstanceAdminClient} from '../src/v2';
20+
21+
describe('Service Path', () => {
22+
it('Setting universe domain should set the service path', async () => {
23+
// Set the environment variable
24+
process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN = 'otherDomain';
25+
26+
const universeDomain = 'someUniverseDomain'; // or your universe domain if not using emulator
27+
const options = {
28+
universeDomain,
29+
};
30+
const bigtable = new Bigtable({
31+
BigtableClient: options,
32+
BigtableInstanceAdminClient: options,
33+
BigtableTableAdminClient: options,
34+
});
35+
// Need to mock getProjectId_ since it normally uses auth and auth isn't
36+
// available in unit tests.
37+
bigtable.getProjectId_ = (
38+
callback: (err: Error | null, projectId?: string) => void
39+
) => {
40+
callback(null, 'projectId');
41+
};
42+
try {
43+
// This is necessary to initialize the bigtable instance admin client.
44+
await bigtable.getInstances({timeout: 1000});
45+
} catch (e) {
46+
assert.strictEqual(
47+
(e as ServiceError).message,
48+
'Total timeout of API google.bigtable.admin.v2.BigtableInstanceAdmin exceeded 1000 milliseconds retrying error Error: 14 UNAVAILABLE: Name resolution failed for target dns:bigtableadmin.someUniverseDomain:443 before any response was received.'
49+
);
50+
} finally {
51+
assert.strictEqual(
52+
(
53+
bigtable.api
54+
.BigtableInstanceAdminClient as BigtableInstanceAdminClient
55+
)['_opts'].servicePath,
56+
`bigtableadmin.${universeDomain}`
57+
);
58+
}
59+
try {
60+
// This will fail in unit tests, but is necessary to initialize the
61+
// bigtable client.
62+
const instance = bigtable.instance('instanceId');
63+
const table = instance.table('tableId');
64+
await table.getRows({gaxOptions: {timeout: 1000}});
65+
} catch (e) {
66+
assert.strictEqual(
67+
(e as ServiceError).message,
68+
'14 UNAVAILABLE: Name resolution failed for target dns:bigtable.someUniverseDomain:443'
69+
);
70+
} finally {
71+
assert.strictEqual(
72+
(bigtable.api.BigtableClient as BigtableClient)['_opts'].servicePath,
73+
`bigtable.${universeDomain}`
74+
);
75+
}
76+
77+
// Clean up the environment variable after the test
78+
delete process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN;
79+
});
80+
it('Setting universe domain and custom endpoint should set the service path to custom endpoint', async () => {
81+
// Set the environment variable
82+
process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN = 'otherDomain';
83+
84+
const universeDomain = 'someUniverseDomain'; // or your universe domain if not using emulator
85+
const apiEndpoint = 'someApiEndpoint';
86+
const options = {
87+
universeDomain,
88+
};
89+
const bigtable = new Bigtable({
90+
apiEndpoint,
91+
BigtableClient: options,
92+
BigtableInstanceAdminClient: options,
93+
BigtableTableAdminClient: options,
94+
});
95+
// Need to mock getProjectId_ since it normally uses auth and auth isn't
96+
// available in unit tests.
97+
bigtable.getProjectId_ = (
98+
callback: (err: Error | null, projectId?: string) => void
99+
) => {
100+
callback(null, 'projectId');
101+
};
102+
try {
103+
// This is necessary to initialize the bigtable instance admin client.
104+
await bigtable.getInstances({timeout: 1000});
105+
} catch (e) {
106+
assert.strictEqual(
107+
(e as ServiceError).message,
108+
'Total timeout of API google.bigtable.admin.v2.BigtableInstanceAdmin exceeded 1000 milliseconds retrying error Error: 14 UNAVAILABLE: Name resolution failed for target dns:someApiEndpoint:443 before any response was received.'
109+
);
110+
} finally {
111+
assert.strictEqual(
112+
(
113+
bigtable.api
114+
.BigtableInstanceAdminClient as BigtableInstanceAdminClient
115+
)['_opts'].servicePath,
116+
apiEndpoint
117+
);
118+
}
119+
try {
120+
// This will fail in unit tests, but is necessary to initialize the
121+
// bigtable client.
122+
const instance = bigtable.instance('instanceId');
123+
const table = instance.table('tableId');
124+
await table.getRows({gaxOptions: {timeout: 1000}});
125+
} catch (e) {
126+
assert.strictEqual(
127+
(e as ServiceError).message,
128+
'14 UNAVAILABLE: Name resolution failed for target dns:someApiEndpoint:443'
129+
);
130+
} finally {
131+
assert.strictEqual(
132+
(bigtable.api.BigtableClient as BigtableClient)['_opts'].servicePath,
133+
apiEndpoint
134+
);
135+
}
136+
137+
// Clean up the environment variable after the test
138+
delete process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN;
139+
});
140+
it('Setting GOOGLE_CLOUD_UNIVERSE_DOMAIN should set the service path', async () => {
141+
const universeDomain = 'someUniverseDomain'; // or your universe domain if not using emulator
142+
143+
// Set the environment variable
144+
process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN = universeDomain;
145+
const bigtable = new Bigtable(); // No options needed, it will pick up the env var
146+
147+
// Need to mock getProjectId_ since it normally uses auth and auth isn't
148+
// available in unit tests.
149+
bigtable.getProjectId_ = (
150+
callback: (err: Error | null, projectId?: string) => void
151+
) => {
152+
callback(null, 'projectId');
153+
};
154+
155+
try {
156+
// This is necessary to initialize the bigtable instance admin client.
157+
await bigtable.getInstances({timeout: 1000});
158+
} catch (e) {
159+
assert.strictEqual(
160+
(e as ServiceError).message,
161+
'Total timeout of API google.bigtable.admin.v2.BigtableInstanceAdmin exceeded 1000 milliseconds retrying error Error: 14 UNAVAILABLE: Name resolution failed for target dns:bigtableadmin.someUniverseDomain:443 before any response was received.'
162+
);
163+
} finally {
164+
assert.strictEqual(
165+
(
166+
bigtable.api
167+
.BigtableInstanceAdminClient as BigtableInstanceAdminClient
168+
)['_opts'].servicePath,
169+
`bigtableadmin.${universeDomain}`
170+
);
171+
}
172+
173+
try {
174+
// This will fail in unit tests, but is necessary to initialize the
175+
// bigtable client.
176+
const instance = bigtable.instance('instanceId');
177+
const table = instance.table('tableId');
178+
await table.getRows({gaxOptions: {timeout: 1000}});
179+
} catch (e) {
180+
assert.strictEqual(
181+
(e as ServiceError).message,
182+
'14 UNAVAILABLE: Name resolution failed for target dns:bigtable.someUniverseDomain:443'
183+
);
184+
} finally {
185+
assert.strictEqual(
186+
(bigtable.api.BigtableClient as BigtableClient)['_opts'].servicePath,
187+
`bigtable.${universeDomain}`
188+
);
189+
}
190+
191+
// Clean up the environment variable after the test
192+
delete process.env.GOOGLE_CLOUD_UNIVERSE_DOMAIN;
193+
});
194+
});

0 commit comments

Comments
 (0)