feat: Add universe metadata handler (#596)

* feat: Add `universe` metadata handler * fix: test
googleapis · Nov 10, 2023 · 0c02016 · 0c02016
1 parent 470a872
commit 0c02016
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -184,20 +184,50 @@ async function fastFailMetadataRequest<T>(
 
 /**
  * Obtain metadata for the current GCE instance
+ *
+ * @see {@link https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys}
+ *
+ * @example
+ * ```
+ * const serviceAccount: {} = await instance('service-accounts/');
+ * const serviceAccountEmail: string = await instance('service-accounts/default/email');
+ * ```
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function instance<T = any>(options?: string | Options) {
   return metadataAccessor<T>('instance', options);
 }
 
 /**
- * Obtain metadata for the current GCP Project.
+ * Obtain metadata for the current GCP project
+ *
+ * @see {@link https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys}
+ *
+ * @example
+ * ```
+ * const projectId: string = await project('project-id');
+ * const numericProjectId: number = await project('numeric-project-id');
+ * ```
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function project<T = any>(options?: string | Options) {
   return metadataAccessor<T>('project', options);
 }
 
+/**
+ * Obtain metadata for the current universe
+ *
+ * @see {@link https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys}
+ *
+ * @example
+ * ```
+ * const universeDomain: string = await universe('universe_domain');
+ * ```
+ */
+export function universe<T>(options?: string | Options) {
+  return metadataAccessor<T>('universe', options);
+}
+
 /*
  * How many times should we retry detecting GCP environment.
  */

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -150,6 +150,19 @@ describe('unit test', () => {
     scope.done();
   });
 
+  it('should query the `universe` type', async () => {
+    const PROPERTY = 'universe_domain';
+    const VALUE = 'my-domain.com';
+
+    const scope = nock(HOST)
+      .get(`${PATH}/universe/${PROPERTY}`)
+      .reply(200, VALUE, HEADERS);
+
+    assert(await gcp.universe(PROPERTY), VALUE);
+
+    scope.done();
+  });
+
   it('should return the request error', async () => {
     const scope = nock(HOST)
       .get(`${PATH}/${TYPE}`)