feat: introduce new bot-framework library

.github/workflows/ci.yaml

@@ -34,7 +34,7 @@ jobs:
       - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
       - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
         with:
-          node-version: ${{ (endsWith(matrix.package, '-utils') || matrix.package == 'canary-bot' || matrix.package == 'datastore-lock' || matrix.package == 'object-selector' || matrix.package == 'release-please' ) && 18 || 14 }}
+          node-version: ${{ (endsWith(matrix.package, '-utils') || matrix.package == 'bot-framework' || matrix.package == 'canary-bot' || matrix.package == 'datastore-lock' || matrix.package == 'object-selector' || matrix.package == 'release-please' ) && 18 || 14 }}
       - run: echo ./packages/${{ matrix.package }}
       - run: cd ./packages/${{ matrix.package }}
       - run: npm ci

packages/bot-framework/.c8rc.json

@@ -0,0 +1,3 @@
+{
+  "exclude": [".mocharc.js", "build/test"]
+}

packages/bot-framework/.dockerignore

@@ -0,0 +1,7 @@
+build/
+coverage/
+node_modules/
+.env
+*.pem
+Dockerfile
+.dockerignore

packages/bot-framework/.eslintignore

@@ -0,0 +1,4 @@
+**/node_modules
+**/coverage
+test/fixtures
+build/

packages/bot-framework/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./node_modules/gts",
+  "root": true
+}

packages/bot-framework/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+build
+coverage

packages/bot-framework/.mocharc.js

@@ -0,0 +1,28 @@
+// 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.
+const config = {
+  "enable-source-maps": true,
+  "throw-deprecation": true,
+  "timeout": 10000
+}
+if (process.env.MOCHA_THROW_DEPRECATION === 'false') {
+  delete config['throw-deprecation'];
+}
+if (process.env.MOCHA_REPORTER) {
+  config.reporter = process.env.MOCHA_REPORTER;
+}
+if (process.env.MOCHA_REPORTER_OUTPUT) {
+  config['reporter-option'] = `output=${process.env.MOCHA_REPORTER_OUTPUT}`;
+}
+module.exports = config

packages/bot-framework/.prettierignore

@@ -0,0 +1,6 @@
+**/node_modules
+**/coverage
+test/fixtures
+build/
+docs/
+protos/

packages/bot-framework/.prettierrc.js

@@ -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
+//
+//      https://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.
+
+module.exports = {
+  ...require('gts/.prettierrc.json')
+}

packages/bot-framework/Dockerfile

@@ -0,0 +1,49 @@
+# Copyright 2021 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.
+
+# Use a multi-stage docker build to limit production dependencies.
+
+# Use the official lightweight Node.js 14 image.
+# https://hub.docker.com/_/node
+FROM node:18-slim AS BUILD
+
+# Create and change to the app directory.
+WORKDIR /usr/src/app
+
+# Copy application dependency manifests to the container image.
+# A wildcard is used to ensure copying both package.json AND package-lock.json (when available).
+# Copying this first prevents re-running npm install on every code change.
+COPY package*.json ./
+
+# Install build dependencies.
+RUN npm ci
+
+# Now copy all the code so we can compile
+COPY . ./
+
+RUN npm run compile
+
+FROM node:18-slim
+
+# Create and change to the app directory.
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+COPY --from=BUILD /usr/src/app/build build
+RUN npm ci --only=production
+
+ENV NODE_ENV "production"
+
+# Run the web service on container startup.
+CMD [ "npm", "--no-update-notifier", "run", "start" ]

packages/bot-framework/README.md

@@ -0,0 +1,18 @@
+# foo
+
+Instructions are provided in [googleapis/repo-automation-bots](https://github.com/googleapis/repo-automation-bots/blob/main/README.md) for deploying and testing your bots.
+
+This bot uses nock for mocking requests to GitHub, and snap-shot-it for capturing responses; This allows updates to the API surface to be treated as a visual diff, rather than tediously asserting against each field.
+
+## Running tests:
+
+`npm test`
+
+## Contributing
+
+If you have suggestions for how foo could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
+
+For more, check out the Contributing Guide.
+
+License
+Apache 2.0 © 2021 Google LLC.

packages/bot-framework/cloudbuild-test.yaml

@@ -0,0 +1,27 @@
+# Copyright 2021 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.
+
+steps:
+  - name: gcr.io/cloud-builders/docker
+    id: 'build-docker'
+    waitFor: ['-']
+    dir: 'packages/'
+    args:
+      - 'build'
+      - '-t'
+      - 'gcr.io/$PROJECT_ID/'
+      - '.'
+
+  # TODO: create container test
+  # TODO: create unit & integration tests

packages/bot-framework/cloudbuild.yaml

@@ -0,0 +1,38 @@
+# Copyright 2021 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.
+
+steps:
+  - name: gcr.io/cloud-builders/npm
+    id: "build"
+    waitFor: ["-"]
+    entrypoint: bash
+    args:
+      - "-e"
+      - "./scripts/build-function.sh"
+      - "$_DIRECTORY"
+
+  - name: gcr.io/cloud-builders/gcloud
+    id: "publish-function"
+    waitFor: ["build"]
+    entrypoint: bash
+    args:
+      - "-e"
+      - "./scripts/publish-function.sh"
+      - "$_DIRECTORY"
+      - "$PROJECT_ID"
+      - "$_BUCKET"
+      - "$_KEY_LOCATION"
+      - "$_KEY_RING"
+      - "$_FUNCTION_REGION"
+      - "nodejs12"