migrate code from googleapis/nodejs-retail

.github/auto-label.yaml

@@ -33,6 +33,7 @@ path:
  mediatranslation: "mediatranslation"
  memorystore: "memorystore"
  monitoring: "monitoring"
+ retail: "retail"
  run: "run"
  scheduler: "cloudscheduler"
  secret-manager: "secretmanager"

.github/workflows/retail.yaml

@@ -0,0 +1,71 @@
+name: retail
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - 'retail/**'
+ - '.github/workflows/retail.yaml'
+ pull_request:
+ paths:
+ - 'retail/**'
+ - '.github/workflows/retail.yaml'
+ pull_request_target:
+ types: [labeled]
+ paths:
+ - 'retail/**'
+ - '.github/workflows/retail.yaml'
+ schedule:
+ - cron: '0 0 * * 0'
+jobs:
+ test:
+ if: ${{ github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' }}
+ runs-on: ubuntu-latest
+ timeout-minutes: 60
+ permissions:
+ contents: 'write'
+ pull-requests: 'write'
+ id-token: 'write'
+ steps:
+ - uses: actions/checkout@v3.1.0
+ with:
+ ref: ${{github.event.pull_request.head.sha}}
+ - uses: 'google-github-actions/auth@v1.0.0'
+ with:
+ workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
+ service_account: 'kokoro-system-test@long-door-651.iam.gserviceaccount.com'
+ create_credentials_file: 'true'
+ access_token_lifetime: 600s
+ - uses: actions/setup-node@v3.5.1
+ with:
+ node-version: 16
+ - run: npm install
+ working-directory: retail
+ - run: npm test
+ working-directory: retail
+ env:
+ MOCHA_REPORTER_SUITENAME: retail
+ MOCHA_REPORTER_OUTPUT: retail_sponge_log.xml
+ MOCHA_REPORTER: xunit
+ - if: ${{ github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' }}
+ uses: actions/github-script@v6
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ script: |
+ try {
+ await github.rest.issues.removeLabel({
+ name: 'actions:force-run',
+ owner: 'GoogleCloudPlatform',
+ repo: 'nodejs-docs-samples',
+ issue_number: context.payload.pull_request.number
+ });
+ } catch (e) {
+ if (!e.message.includes('Label does not exist')) {
+ throw e;
+ }
+ }
+ - if: ${{ github.event_name == 'schedule' && always() }}
+ run: |
+ curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L
+ chmod +x ./flakybot
+ ./flakybot --repo GoogleCloudPlatform/nodejs-docs-samples --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}

.github/workflows/workflows.json

@@ -73,6 +73,7 @@
  "monitoring/opencensus",
  "monitoring/prometheus",
  "monitoring/snippets",
+ "retail",
  "scheduler",
  "security-center/snippets",
  "service-directory/snippets",

CODEOWNERS

@@ -73,3 +73,6 @@ texttospeech @GoogleCloudPlatform/dee-data-ai @GoogleCloudPlatform/nodejs-sample
 translate @GoogleCloudPlatform/dee-data-ai @GoogleCloudPlatform/nodejs-samples-reviewers
 video-intelligence @GoogleCloudPlatform/dee-data-ai @GoogleCloudPlatform/nodejs-samples-reviewers
 vision @GoogleCloudPlatform/dee-data-ai @GoogleCloudPlatform/nodejs-samples-reviewers
+
+# Self-service
+retail @GoogleCloudPlatform/cloud-retail-team @GoogleCloudPlatform/nodejs-samples-reviewers

retail/.mocharc.json

@@ -0,0 +1,5 @@
+{
+ "timeout": "600000",
+ "recursive": true,
+ "spec": ["test/*.js", "interactive-tutorials/test/*.js"]
+}

retail/interactive-tutorials/README.md

@@ -0,0 +1,64 @@
+
+## Get started with Google Cloud Retail
+
+### Select your project and enable the Retail API
+
+Google Cloud organizes resources into projects. This lets you
+collect all the related resources for a single application in one place.
+
+If you don't have a Google Cloud project yet or you're not the Owner of an existing one, you can
+[create a new project](https://console.cloud.google.com/projectcreate).
+
+After the project is created, set your PROJECT_ID to a ```project``` variable.
+1. Run the following command in Terminal:
+ ```bash
+ gcloud config set project <YOUR_PROJECT_ID>
+ ```
+
+1. Check that the Retail API is enabled for your Project in the [Admin Console](https://console.cloud.google.com/ai/retail/).
+
+### Set up authentication
+
+To run a code sample from the Cloud Shell, you need to authenticate. To do this, use the Application Default Credentials.
+
+1. Set your user credentials to authenticate your requests to the Retail API
+
+ ```bash
+ gcloud auth application-default login
+ ```
+
+1. Type `Y` and press **Enter**. Click the link in Terminal. A browser window should appear asking you to log in using your Google account.
+
+1. Provide the Google Auth Library with access to your credentials and paste the code from the browser to the Terminal.
+
+1. Run the code sample and check the Retail API in action.
+
+**Note**: Click the copy button on the side of the code box to paste the command in the Cloud Shell terminal and run it.
+
+### Set the GCLOUD_PROJECT environment variable
+
+Because you are going to run the code samples in your own Google Cloud project, you should specify the **project_number** as an environment variable. It will be used in every request to the Retail API.
+
+1. You can find the ```project_number``` in the **Home/Dashboard/Project Info card**.
+
+1. Set the environment variable with the following command:
+ ```bash
+ export GCLOUD_PROJECT=<YOUR_GCLOUD_PROJECT>
+ ```
+
+### Install Google Cloud Retail libraries
+
+To install all the dependencies, run
+
+```
+cd cloudshell_open/nodejs-retail
+npm install
+```
+
+### Running the code samples
+Samples are in the `search/`, `products/`, `events/` directories.
+To execute an individual code sample, invoke `node` with a file as a parameter at the command line prompt, e.g.:
+
+```
+node search/search-simple-query.js
+```

retail/interactive-tutorials/events/import-user-events-big-query.js

@@ -0,0 +1,84 @@
+// Copyright 2022 Google Inc. All Rights Reserved.
+//
+// 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
+//
+// http://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.
+
+'use strict';
+
+async function main(datasetId) {
+ // Imports the Google Cloud client library.
+ const {UserEventServiceClient} = require('@google-cloud/retail').v2;
+
+ // Instantiates a client.
+ const retailClient = new UserEventServiceClient();
+
+ const projectId = await retailClient.getProjectId();
+ const dataSchema = 'user_event';
+ const tableId = 'events'; // TO CHECK ERROR HANDLING USE THE TABLE OF INVALID USER EVENTS
+
+ // Placement
+ const parent = `projects/${projectId}/locations/global/catalogs/default_catalog`; // TO CHECK ERROR HANDLING PASTE THE INVALID CATALOG NAME HERE
+
+ // The desired input location of the data.
+ const inputConfig = {
+ bigQuerySource: {
+ projectId,
+ datasetId,
+ tableId,
+ dataSchema,
+ },
+ };
+
+ const IResponseParams = {
+ IImportUserEventsResponse: 0,
+ IImportMetadata: 1,
+ IOperation: 2,
+ };
+
+ const callImportUserEvents = async () => {
+ // Construct request
+ const request = {
+ parent,
+ inputConfig,
+ };
+
+ console.log('Import request: ', request);
+
+ // Run request
+ const [operation] = await retailClient.importUserEvents(request);
+ const response = await operation.promise();
+ const result = response[IResponseParams.IImportMetadata];
+ console.log(
+ `Number of successfully imported events: ${result.successCount | 0}`
+ );
+ console.log(
+ `Number of failures during the importing: ${result.failureCount | 0}`
+ );
+ console.log(`Operation result: ${JSON.stringify(response)}`);
+ };
+
+ console.log('Start events import');
+ await callImportUserEvents();
+ console.log('Events import finished');
+}
+
+process.on('unhandledRejection', err => {
+ console.error(err.message);
+ process.exitCode = 1;
+});
+
+main(
+ ...(() => {
+ const argv = process.argv.slice(2);
+ return argv.length ? argv : ['user_events'];
+ })()
+);

retail/interactive-tutorials/events/import-user-events-gcs.js

@@ -0,0 +1,91 @@
+// Copyright 2022 Google Inc. All Rights Reserved.
+//
+// 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
+//
+// http://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.
+
+'use strict';
+
+async function main(bucketName) {
+ // Imports the Google Cloud client library.
+ const {UserEventServiceClient} = require('@google-cloud/retail').v2;
+
+ // Instantiates a client.
+ const retailClient = new UserEventServiceClient();
+
+ const projectId = await retailClient.getProjectId();
+
+ //TODO(developer) set the environment variable value which will be used as the bucket name
+ const gcsBucket = `gs://${bucketName}`;
+ const gcsErrorsBucket = `gs://${bucketName}/error`;
+ const gcsEventsObject = 'user_events.json'; // TO CHECK ERROR HANDLING USE THE JSON WITH INVALID USER EVENTS
+
+ // Placement
+ const parent = `projects/${projectId}/locations/global/catalogs/default_catalog`; // TO CHECK ERROR HANDLING PASTE THE INVALID CATALOG NAME HERE
+
+ // The desired input location of the data.
+ const inputConfig = {
+ gcsSource: {
+ inputUris: [gcsBucket + '/' + gcsEventsObject],
+ dataSchema: 'user_event',
+ },
+ };
+
+ // The desired location of errors incurred during the Import.
+ const errorsConfig = {
+ gcsPrefix: gcsErrorsBucket,
+ };
+
+ const IResponseParams = {
+ IImportUserEventsResponse: 0,
+ IImportMetadata: 1,
+ IOperation: 2,
+ };
+
+ const callImportUserEvents = async () => {
+ // Construct request
+ const request = {
+ parent,
+ inputConfig,
+ errorsConfig,
+ };
+
+ console.log('Import request: ', request);
+
+ // Run request
+ const [operation] = await retailClient.importUserEvents(request);
+ const response = await operation.promise();
+ const result = response[IResponseParams.IImportMetadata];
+ console.log(
+ `Number of successfully imported events: ${result.successCount | 0}`
+ );
+ console.log(
+ `Number of failures during the importing: ${result.failureCount | 0}`
+ );
+ console.log(`Operation result: ${JSON.stringify(response)}`);
+ };
+
+ console.log('Start events import');
+ await callImportUserEvents();
+ console.log('Events import finished');
+}
+
+process.on('unhandledRejection', err => {
+ console.error(err.message);
+ process.exitCode = 1;
+});
+
+main(
+ ...(() => {
+ const argv = process.argv.slice(2);
+ return argv.length ? argv : [process.env['EVENTS_BUCKET_NAME']];
+ })()
+);