samples: add schema samples, typescript sample support

samples/createAvroSchema.js

@@ -0,0 +1,67 @@
+// 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.
+
+/**
+ * This application demonstrates how to perform basic operations on
+ * subscriptions with the Google Cloud Pub/Sub API.
+ *
+ * For more information, see the README.md under /pubsub and the documentation
+ * at https://cloud.google.com/pubsub/docs.
+ */
+
+'use strict';
+
+// sample-metadata:
+//   title: Create an Avro based Schema
+//   description: Creates a new schema definition on a project, using Avro
+//   usage: node createAvroSchema.js <schema-name> <avsc-filename>
+
+function main(
+  schemaName = 'YOUR_SCHEMA_NAME',
+  avscFile = 'path/to/an/avro/schema/file/(.avsc)/formatted/in/json'
+) {
+  // [START pubsub_create_avro_schema]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const schemaName = 'YOUR_SCHEMA_NAME';
+  // const avscFile = 'path/to/an/avro/schema/file/(.avsc)/formatted/in/json';
+
+  // Imports the Google Cloud client library
+  const {PubSub, SchemaTypes} = require('@google-cloud/pubsub');
+
+  const fs = require('fs');
+
+  // Creates a client; cache this for further use
+  const pubSubClient = new PubSub();
+
+  async function createAvroSchema() {
+    const definition = fs.readFileSync(avscFile).toString();
+    const schema = await pubSubClient.createSchema(
+      schemaName,
+      SchemaTypes.Avro,
+      definition
+    );
+    console.log(`Schema ${schema.name} created.`);
+  }
+
+  createAvroSchema();
+  // [END pubsub_create_avro_schema]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

samples/createTopicWithSchema.js

@@ -0,0 +1,56 @@
+// Copyright 2019-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
+//
+//     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.
+
+/**
+ * This sample demonstrates how to perform basic operations on topics with
+ * the Google Cloud Pub/Sub API.
+ *
+ * For more information, see the README.md under /pubsub and the documentation
+ * at https://cloud.google.com/pubsub/docs.
+ */
+
+'use strict';
+
+// sample-metadata:
+//   title: Create Topic With Schema
+//   description: Creates a new topic, with a schema definition.
+//   usage: node createTopicWithSchema.js <topic-name>
+
+async function main(topicName = 'YOUR_TOPIC_NAME') {
+  // [START pubsub_create_topic]
+  /**
+   * TODO(developer): Uncomment this variable before running the sample.
+   */
+  // const topicName = 'YOUR_TOPIC_NAME';
+
+  // Imports the Google Cloud client library
+  const {PubSub} = require('@google-cloud/pubsub');
+
+  // Creates a client; cache this for further use
+  const pubSubClient = new PubSub();
+
+  async function createTopic() {
+    // Creates a new topic
+    await pubSubClient.createTopic(topicName);
+    console.log(`Topic ${topicName} created.`);
+  }
+
+  createTopic();
+  // [END pubsub_create_topic]
+}
+
+main(...process.argv.slice(2)).catch(e => {
+  console.error(e);
+  process.exitCode = -1;
+});

samples/package.json

@@ -11,15 +11,21 @@
     "node": ">=10"
   },
   "scripts": {
-    "test": "mocha system-test --timeout 600000"
+    "test": "mocha build/system-test --timeout 600000",
+    "pretest": "npm run compile",
+    "compile": "tsc -p . && cp *.js build/ && cp -p system-test/*.js build/system-test/",
+    "precompile": "gts clean"
   },
   "dependencies": {
     "@google-cloud/pubsub": "^2.11.0",
     "@opentelemetry/api": "^0.18.1",
-    "@opentelemetry/tracing": "^0.18.2"
+    "@opentelemetry/tracing": "^0.18.2",
+    "avro-js": "^1.10.1"
   },
   "devDependencies": {
+    "@types/chai": "^4.2.16",
     "chai": "^4.2.0",
+    "gts": "^3.1.0",
     "mocha": "^8.0.0",
     "uuid": "^8.0.0"
   }

samples/synchronousPull.js

@@ -69,7 +69,7 @@ function main(
     }
 
     if (ackIds.length !== 0) {
-      // Acknowledge all of the messages. You could also ackknowledge
+      // Acknowledge all of the messages. You could also acknowledge
       // these individually, but this is more efficient.
       const ackRequest = {
         subscription: formattedSubscription,

samples/system-test/fixtures/avro-avsc.json

@@ -0,0 +1 @@
+{"name":"Pet","type":"record","fields":[{"name":"kind","type":{"name":"Kind","type":"enum","symbols":["CAT","DOG"]}},{"name":"name","type":"string"}]}

samples/system-test/schema.test.ts

@@ -0,0 +1,92 @@
+// 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
+//
+//     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.
+
+import {PubSub} from '@google-cloud/pubsub';
+import {assert} from 'chai';
+import {describe, it, before, after} from 'mocha';
+import * as cp from 'child_process';
+import * as uuid from 'uuid';
+
+const execSync = (cmd: string) => cp.execSync(cmd, {encoding: 'utf-8'});
+
+describe('schema', () => {
+  const projectId = process.env.GCLOUD_PROJECT;
+  const pubsub = new PubSub({projectId});
+  const runId = uuid.v4();
+  console.log(`Topics runId: ${runId}`);
+  const topicNameOne = `schema-top1-${runId}`;
+  const subscriptionNameOne = `schema-sub1-${runId}`;
+  const fullTopicNameOne = `projects/${projectId}/topics/${topicNameOne}`;
+  const schemaNameOne = `schema1-${runId}`;
+
+  const commandFor = (action: string) => `node ${action}.js`;
+
+  before(async () => {
+    const [topic] = await pubsub.createTopic(topicNameOne);
+    console.log('topic', topic);
+    console.log(
+      'sub',
+      await pubsub.createSubscription(topic, subscriptionNameOne)
+    );
+  });
+
+  async function cleanSchemas() {
+    const schemas = [];
+    for await (const s of pubsub.listSchemas()) {
+      schemas.push(s.delete());
+    }
+    await Promise.all(schemas);
+  }
+
+  async function cleanTopics() {
+    const [topics] = await pubsub.getTopics();
+    await Promise.all(
+      topics.filter(x => x.name.endsWith(runId)).map(x => x.delete())
+    );
+  }
+
+  async function cleanSubs() {
+    const [subscriptions] = await pubsub.getSubscriptions();
+    await Promise.all(
+      subscriptions.filter(x => x.name.endsWith(runId)).map(x => x.delete())
+    );
+  }
+
+  after(async () => {
+    await cleanSubs();
+    await cleanTopics();
+    await cleanSchemas();
+  });
+
+  it('should create an avro schema', async () => {
+    const output = execSync(
+      `${commandFor(
+        'createAvroSchema'
+      )} ${schemaNameOne} system-test/fixtures/avro-avsc.json`
+    );
+    assert.include(output, schemaNameOne);
+    assert.include(output, 'created.');
+
+    let found = false;
+    for await (const s of pubsub.listSchemas()) {
+      if (s.name.endsWith(schemaNameOne)) {
+        found = true;
+        break;
+      }
+    }
+
+    await cleanSchemas();
+    assert.ok(found, 'created schema was not found');
+  });
+});

samples/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./node_modules/gts/tsconfig-google.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "build",
+    "resolveJsonModule": true,
+    "lib": [
+      "es2018",
+      "dom"
+    ]
+  },
+  "include": [
+    "./*.ts",
+    "system-test/*.ts"
+  ]
+}

src/index.ts

@@ -115,6 +115,18 @@ export {
   Snapshot,
 } from './snapshot';
 export {Message} from './subscriber';
+export {
+  Schema,
+  CreateSchemaResponse,
+  ISchema,
+  SchemaType,
+  SchemaTypes,
+  ICreateSchemaRequest,
+  SchemaEncoding,
+  SchemaView,
+  SchemaViews,
+  Encodings,
+} from './schema';
 export {
   PushConfig,
   SubscriptionMetadata,