feat: add TypeScript samples support

.github/.OwlBot.lock.yaml

@@ -0,0 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# 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.
+docker:
+  image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs-mono-repo:latest
+  digest: sha256:85bf089b45ad70d1ec02d9d628a0051a06bb63fb79f6b740f787d1a34347f732
+

.github/.OwlBot.yaml

@@ -0,0 +1,22 @@
+# Copyright 2023 Google LLC
+#
+# 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.
+docker:
+  image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs-mono-repo:latest
+
+deep-remove-regex:
+  - /owl-bot-staging
+
+deep-copy-regex:
+  - source: (.*)/(.*).js
+    dest: /owl-bot-staging/$1/$2

.github/workflows/scheduler.yaml

@@ -1,3 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# 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.
+
 name: scheduler
 on:
   push:
@@ -41,6 +55,8 @@ jobs:
         node-version: 16
     - run: npm install
       working-directory: scheduler
+    - run: npm run build
+      working-directory: scheduler
     - run: npm test
       working-directory: scheduler
       env:

owlbot.py

@@ -0,0 +1,104 @@
+# Copyright 2023 Google LLC
+#
+# 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.
+
+import re
+import subprocess
+from pathlib import Path
+
+from synthtool import shell
+from synthtool.log import logger
+
+_TOOLS_DIRECTORY = "/synthtool"
+_EXCLUDED_DIRS = [r"node_modules", r"^\."]
+
+
+def walk_through_owlbot_dirs(dir: Path, search_for_changed_files: bool) -> list[str]:
+    """
+    Walks through all sample directories
+    Returns:
+    A list of directories
+    """
+    owlbot_dirs: list[str] = []
+    packages_to_exclude = _EXCLUDED_DIRS
+    if search_for_changed_files:
+        try:
+            # Need to run this step first in the post processor since we only clone
+            # the branch the PR is on in the Docker container
+            output = subprocess.run(
+                ["git", "fetch", "origin", "main:main", "--deepen=200"]
+            )
+            output.check_returncode()
+        except subprocess.CalledProcessError as e:
+            if e.returncode == 128:
+                logger.info(f"Error: ${e.output}; skipping fetching main")
+            else:
+                raise e
+    for path_object in dir.glob("**/package.json"):
+        object_dir = str(Path(path_object).parents[0])
+        if path_object.is_file() and object_dir != str(dir) and not re.search(
+            "(?:% s)" % "|".join(packages_to_exclude), str(Path(path_object))
+        ):
+            if search_for_changed_files:
+                if (
+                    subprocess.run(
+                        [
+                            "git",
+                            "diff",
+                            "--quiet",
+                            "main...",
+                            object_dir
+                        ]
+                    ).returncode
+                    == 1
+                ):
+                    owlbot_dirs.append(object_dir)
+            else:
+                owlbot_dirs.append(object_dir)
+    for path_object in dir.glob("owl-bot-staging/*"):
+        owlbot_dirs.append(
+            f"{Path(path_object).parents[1]}/packages/{Path(path_object).name}"
+        )
+    return owlbot_dirs
+
+
+def typeless_samples_hermetic(output_path: str, targets: str, hide_output: bool=False) -> None:
+    """
+    Converts TypeScript samples in the current Node.js library
+    to JavaScript samples. Run this step before fix() and friends.
+    Assumes that typeless-sample-bot is already installed in a well
+    known location on disk (node_modules/.bin).
+    This is currently an optional, opt-in part of an individual repo's
+    OwlBot.py, and must be called from there before calling owlbot_main.
+    """
+    logger.debug("Run typeless sample bot")
+    shell.run(
+        [
+            f"{_TOOLS_DIRECTORY}/node_modules/.bin/typeless-sample-bot",
+            "--outputpath",
+            output_path,
+            "--targets",
+            targets,
+            "--recursive",
+        ],
+        check=False,
+        hide_output=hide_output,
+    )
+
+
+# Retrieve list of directories
+dirs: list[str] = walk_through_owlbot_dirs(Path.cwd(), search_for_changed_files=True)
+for d in dirs:
+    logger.debug(f"Directory: {d}")
+    # Run typeless bot to convert from TS -> JS
+    typeless_samples_hermetic(output_path=d, targets=d)

scheduler/createJob.js → scheduler/createJob.ts

@@ -1,4 +1,4 @@
-// Copyright 2018 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,26 +17,32 @@
 //   description: Create a job that posts to /log_payload on an App Engine service.
 //   usage: node createJob.js [project-id] [location-id] [app-engine-service-id]
 
+import {protos, CloudSchedulerClient} from '@google-cloud/scheduler';
+
 /**
  * Create a job with an App Engine target via the Cloud Scheduler API
  */
-async function createJob(projectId, locationId, serviceId) {
+async function createJob(
+  projectId: string,
+  locationId: string,
+  serviceId: string
+) {
   // [START cloudscheduler_create_job]
   const scheduler = require('@google-cloud/scheduler');
 
   // Create a client.
-  const client = new scheduler.CloudSchedulerClient();
+  const client: CloudSchedulerClient = new scheduler.CloudSchedulerClient();
 
   // TODO(developer): Uncomment and set the following variables
   // const projectId = "PROJECT_ID"
   // const locationId = "LOCATION_ID"
   // const serviceId = "my-serivce"
 
   // Construct the fully qualified location path.
-  const parent = client.locationPath(projectId, locationId);
+  const parent: string = client.locationPath(projectId, locationId);
 
   // Construct the request body.
-  const job = {
+  const job: protos.google.cloud.scheduler.v1.IJob = {
     appEngineHttpTarget: {
       appEngineRouting: {
         service: serviceId,
@@ -49,19 +55,20 @@ async function createJob(projectId, locationId, serviceId) {
     timeZone: 'America/Los_Angeles',
   };
 
-  const request = {
+  const request: protos.google.cloud.scheduler.v1.ICreateJobRequest = {
     parent: parent,
     job: job,
   };
 
   // Use the client to send the job creation request.
   const [response] = await client.createJob(request);
+  // await client.createJob(request);
   console.log(`Created job: ${response.name}`);
   // [END cloudscheduler_create_job]
 }
 
 const args = process.argv.slice(2);
-createJob(...args).catch(err => {
+createJob(args[0], args[1], args[2]).catch(err => {
   console.error(err.message);
   process.exitCode = 1;
 });

scheduler/package.json

@@ -6,20 +6,23 @@
     "node": ">=12.0.0"
   },
   "files": [
-    "*.js"
+    "*.js", "*.ts"
   ],
   "license": "Apache-2.0",
   "scripts": {
+    "build": "tsc",
     "start": "node app.js",
-    "test": "mocha --timeout 10000 --exit"
+    "test": "mocha --require ts-node/register test/*.ts --timeout 10000 --exit"
   },
   "dependencies": {
     "@google-cloud/scheduler": "^3.0.5",
     "body-parser": "^1.18.3",
     "express": "^4.16.4"
   },
   "devDependencies": {
+    "@types/mocha": "^10.0.1",
     "chai": "^4.2.0",
-    "mocha": "^10.0.0"
+    "mocha": "^10.0.0",
+    "ts-node": "^10.9.1"
   }
 }

scheduler/test/test.samples.js → scheduler/test/test.samples.ts

@@ -1,4 +1,4 @@
-// Copyright 2018 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -14,33 +14,33 @@
 
 'use strict';
 
-const {CloudSchedulerClient} = require('@google-cloud/scheduler');
+import {CloudSchedulerClient} from '@google-cloud/scheduler';
+
 const {assert} = require('chai');
-const {describe, it, before} = require('mocha');
 const cp = require('child_process');
 
-const client = new CloudSchedulerClient();
-const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+const client: CloudSchedulerClient = new CloudSchedulerClient();
+const execSync = (cmd: String) => cp.execSync(cmd, {encoding: 'utf-8'});
 const LOCATION_ID = process.env.LOCATION_ID || 'us-central1';
 const SERVICE_ID = 'my-service';
 
 describe('Cloud Scheduler Sample Tests', () => {
-  let PROJECT_ID, stdout;
+  let PROJECT_ID: String, stdout: String;
 
   before(async () => {
     PROJECT_ID = await client.getProjectId();
   });
 
   after(async () => {
-    const jobName = stdout && stdout.trim().split(' ').slice(-1);
+    const jobName = (stdout && stdout.trim().split(' ').slice(-1))[0];
     if (jobName) {
       await client.deleteJob({name: jobName});
     }
   });
 
   it('should create a scheduler job', async () => {
     stdout = execSync(
-      `node createJob.js ${PROJECT_ID} ${LOCATION_ID} ${SERVICE_ID}`
+      `node --loader ts-node/esm createJob.ts ${PROJECT_ID} ${LOCATION_ID} ${SERVICE_ID}`
     );
     assert.match(stdout, /Created job/);
   });

scheduler/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+      "target": "ESNext",
+      "strict": true,
+      "noImplicitAny": false,
+      "moduleResolution": "node",
+    }
+  }