fix: Update Request Metadata to include user id (GoogleCloudPlatform#10490)

dmoonat · web-flow · commit 38af4e55cbd0 · 2023-08-07T19:32:16.000Z
## Update search sample Fixes Added the Request metadata to include the user id Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google. ## Checklist - [x] I have followed [Sample Guidelines from AUTHORING_GUIDE.MD](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md) - [x] README is updated to include [all relevant information](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#readme-file) - [x] **Tests** pass: `nox -s py-3.9` (see [Test Environment Setup](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [x] **Lint** pass: `nox -s lint` (see [Test Environment Setup](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [ ] These samples need a new **API enabled** in testing projects to pass (let us know which ones) - [ ] These samples need a new/updated **env vars** in testing projects set to pass (let us know which ones) - [ ] This sample adds a new sample directory, and I updated the [CODEOWNERS file](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/.github/CODEOWNERS) with the codeowners for this sample - [ ] This sample adds a new **Product API**, and I updated the [Blunderbuss issue/PR auto-assigner](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/.github/blunderbuss.yml) with the codeowners for this sample - [x] Please **merge** this PR for me once it is approved
diff --git a/contentwarehouse/snippets/create_get_delete_document_schema_test.py b/contentwarehouse/snippets/create_get_delete_document_schema_test.py
@@ -36,12 +36,12 @@ def test_create_document_schema(request: pytest.fixture) -> None:
 
     assert "display_name" in response
 
-    document_schema_id = response.name.split('/')[-1]
+    document_schema_id = response.name.split("/")[-1]
 
     request.config.cache.set("document_schema_id", document_schema_id)
 
 
-@pytest.mark.dependency(name="get", depends=['create'])
+@pytest.mark.dependency(name="get", depends=["create"])
 def test_get_document_schema(request: pytest.fixture) -> None:
     project_number = test_utilities.get_project_number(project_id)
 
@@ -56,7 +56,7 @@ def test_get_document_schema(request: pytest.fixture) -> None:
     assert "display_name" in response
 
 
-@pytest.mark.dependency(name="delete", depends=['get'])
+@pytest.mark.dependency(name="delete", depends=["get"])
 def test_delete_document_schema(request: pytest.fixture) -> None:
     project_number = test_utilities.get_project_number(project_id)
 
diff --git a/contentwarehouse/snippets/search_documents_sample.py b/contentwarehouse/snippets/search_documents_sample.py
@@ -22,12 +22,11 @@
 # project_number = 'YOUR_PROJECT_NUMBER'
 # location = 'YOUR_PROJECT_LOCATION' # Format is 'us' or 'eu'
 # document_query_text = 'YOUR_DOCUMENT_QUERY'
+# user_id = 'user:YOUR_SERVICE_ACCOUNT_ID' # Format is "user:xxxx@example.com"
 
 
 def search_documents_sample(
-    project_number: str,
-    location: str,
-    document_query_text: str,
+    project_number: str, location: str, document_query_text: str, user_id: str
 ) -> None:
     # Create a client
     client = contentwarehouse.DocumentServiceClient()
@@ -53,9 +52,14 @@ def search_documents_sample(
         histogram_query='count("DocumentSchemaId")'
     )
 
+    request_metadata = contentwarehouse.RequestMetadata(
+        user_info=contentwarehouse.UserInfo(id=user_id)
+    )
+
     # Define request
     request = contentwarehouse.SearchDocumentsRequest(
         parent=parent,
+        request_metadata=request_metadata,
         document_query=document_query,
         histogram_queries=[histogram_query],
     )
diff --git a/contentwarehouse/snippets/search_documents_sample_test.py b/contentwarehouse/snippets/search_documents_sample_test.py
@@ -22,6 +22,7 @@
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 location = "us"  # Format is 'us' or 'eu'
 document_query_text = "document"
+user_id = "user:xxxx@example.com"
 
 
 def test_search_documents(capsys: pytest.CaptureFixture) -> None:
@@ -30,6 +31,7 @@ def test_search_documents(capsys: pytest.CaptureFixture) -> None:
         project_number=project_number,
         location=location,
         document_query_text=document_query_text,
+        user_id=user_id,
     )
     out, _ = capsys.readouterr()
 
