@causa/workspace-google 0.3.1 → 0.5.0

package/README.md

@@ -35,6 +35,12 @@ The following emulators are implemented:
 - `google.pubSub`: The Pub/Sub emulator from the `gcloud` tools. It automatically creates the topics for all event topics found in the Causa workspace. `events.broker` must be set to `google.pubSub` for this.
 - `google.spanner`: The Spanner emulator. It automatically creates all the Spanner databases defined in the Causa workspace, and sets up their DDLs. See the `google.spanner` [configuration](./src/configurations/google.ts) for more details.
 
+### Backfilling
+
+Backfilling is supported when `google.pubSub` is set as the `events.broker`. Temporary triggers can be created for Cloud Run services, by referencing them using the format `[[projects/<projectId>/]locations/<location>/]services/<name>/path-to-trigger`.
+
+When no source is specified, the default is to fetch events to backfill from the BigQuery dataset configured in `google.pubSub.bigQueryStorage`. A custom BigQuery table can also be set as source using the `bq://<projectId>.<datasetId>.<tableId>` format. It should have the `data` and `attributes` columns.
+
 ### Secrets backend
 
 This module implements the `google.secretManager` secret backend, allowing fetching secrets from the Google Secret Manager service. Here are some example of how secrets with the `google.secretManager` backend should be defined:
@@ -114,3 +120,11 @@ The Google module provides several infrastructure processors, which can be used
 [GoogleServicesEnable](./src/functions/google-services-enable.ts) is the same underlying function as the `cs google enableServices` command. It enables GCP services before preparing or deploying the infrastructure.
 
 Although infrastructure as code tools usually expose this feature as well (e.g. the [`google_project_service`](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_project_service) Terraform resource), it might be more convenient to enable all the required services before running those tools. It avoids having to define dependencies between the services and all the actual resources being deployed.
+
+### `GoogleSpannerWriteDatabases`
+
+[GoogleSpannerWriteDatabases](./src/functions/google-spanner-write-databases.ts) writes a configuration file for each Spanner database, such that it can be picked up by the Causa Spanner Terraform module. This allows automatic setup of Spanner databases and their DDLs.
+
+### `GooglePubSubWriteTopics`
+
+[GooglePubSubWriteTopics](./src/functions/google-pubsub-write-topics.ts) writes a configuration file for each event topic, such that it can be picked up by the Causa Pub/Sub Terraform module. This allows automatic setup of Pub/Sub topics, and optionally of the corresponding BigQuery tables.

package/dist/backfilling/bigquery.d.ts

@@ -0,0 +1,53 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { BackfillEvent, BackfillEventsSource } from '@causa/workspace-core';
+/**
+ * An events source that reads events from a BigQuery table.
+ */
+export declare class BigQueryEventsSource implements BackfillEventsSource {
+    readonly tableId: string;
+    readonly filter?: string | undefined;
+    /**
+     * The BigQuery client.
+     */
+    private readonly bigQuery;
+    /**
+     * The job from which the events are read.
+     */
+    private job;
+    /**
+     * The request for the next page of results.
+     * If this is `null` after initializing the job, there are no more results.
+     */
+    private nextPageRequest;
+    /**
+     * The logger.
+     */
+    private readonly logger;
+    /**
+     * Creates a new events source that reads events from a BigQuery table.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param tableId The ID of the BigQuery table from which the events should be read.
+     * @param filter A SQL boolean expression that filters the events from the table.
+     */
+    constructor(context: WorkspaceContext, tableId: string, filter?: string | undefined);
+    /**
+     * Creates a BigQuery job that reads the events from the table.
+     * The `data` and `attributes` columns are read to get the corresponding event properties.
+     * If a filter was specified, it is applied to the query as a where clause.
+     *
+     * @returns The BigQuery job that reads the events from the table.
+     */
+    private createJob;
+    getBatch(): Promise<BackfillEvent[] | null>;
+    dispose(): Promise<void>;
+    /**
+     * Tries to create a new {@link BigQueryEventsSource} from the given source string.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param source The string representing the source, in the format `bq://<projectId>.<datasetId>.<tableId>`.
+     * @param filter A SQL boolean expression that filters the events from the table.
+     * @returns A new {@link BigQueryEventsSource} if the source string is valid, otherwise `null`.
+     */
+    static fromSourceAndFilter(context: WorkspaceContext, source: string, filter?: string): Promise<BigQueryEventsSource | null>;
+}

package/dist/backfilling/bigquery.js

@@ -0,0 +1,99 @@
+import { BigQueryService } from '../services/index.js';
+/**
+ * The number of rows (events) in a single batch.
+ */
+const BIGQUERY_MAX_RESULTS = 10000;
+/**
+ * An events source that reads events from a BigQuery table.
+ */
+export class BigQueryEventsSource {
+    tableId;
+    filter;
+    /**
+     * The BigQuery client.
+     */
+    bigQuery;
+    /**
+     * The job from which the events are read.
+     */
+    job = null;
+    /**
+     * The request for the next page of results.
+     * If this is `null` after initializing the job, there are no more results.
+     */
+    nextPageRequest = null;
+    /**
+     * The logger.
+     */
+    logger;
+    /**
+     * Creates a new events source that reads events from a BigQuery table.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param tableId The ID of the BigQuery table from which the events should be read.
+     * @param filter A SQL boolean expression that filters the events from the table.
+     */
+    constructor(context, tableId, filter) {
+        this.tableId = tableId;
+        this.filter = filter;
+        this.bigQuery = context.service(BigQueryService).bigQuery;
+        this.logger = context.logger;
+    }
+    /**
+     * Creates a BigQuery job that reads the events from the table.
+     * The `data` and `attributes` columns are read to get the corresponding event properties.
+     * If a filter was specified, it is applied to the query as a where clause.
+     *
+     * @returns The BigQuery job that reads the events from the table.
+     */
+    async createJob() {
+        let query = `
+      SELECT
+        data,
+        attributes,
+      FROM
+        \`${this.tableId}\``;
+        if (this.filter) {
+            query += `
+      WHERE
+        (${this.filter})`;
+        }
+        this.logger.debug(`Creating BigQuery job from query '${query}'.`);
+        const [job] = await this.bigQuery.createQueryJob(query);
+        return job;
+    }
+    async getBatch() {
+        if (!this.job) {
+            this.job = await this.createJob();
+        }
+        else if (!this.nextPageRequest) {
+            return null;
+        }
+        const [rows, nextPageRequest] = await this.job.getQueryResults(this.nextPageRequest ?? {
+            autoPaginate: false,
+            maxResults: BIGQUERY_MAX_RESULTS,
+        });
+        this.nextPageRequest = nextPageRequest ?? null;
+        return rows.map((row) => ({
+            data: Buffer.from(row.data),
+            attributes: JSON.parse(row.attributes),
+        }));
+    }
+    async dispose() { }
+    /**
+     * Tries to create a new {@link BigQueryEventsSource} from the given source string.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param source The string representing the source, in the format `bq://<projectId>.<datasetId>.<tableId>`.
+     * @param filter A SQL boolean expression that filters the events from the table.
+     * @returns A new {@link BigQueryEventsSource} if the source string is valid, otherwise `null`.
+     */
+    static async fromSourceAndFilter(context, source, filter) {
+        const match = source.match(/^bq:\/\/(?<tableId>.+)$/);
+        if (!match?.groups?.tableId) {
+            return null;
+        }
+        const tableId = match.groups.tableId;
+        return new BigQueryEventsSource(context, tableId, filter);
+    }
+}

package/dist/backfilling/index.d.ts

@@ -0,0 +1,2 @@
+export { BigQueryEventsSource } from './bigquery.js';
+export { PubSubBackfillEventPublisher } from './pubsub.js';

package/dist/backfilling/index.js

@@ -0,0 +1,2 @@
+export { BigQueryEventsSource } from './bigquery.js';
+export { PubSubBackfillEventPublisher } from './pubsub.js';

package/dist/backfilling/pubsub.d.ts

@@ -0,0 +1,34 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { BackfillEvent, BackfillEventPublisher } from '@causa/workspace-core';
+/**
+ * A publisher that publishes events to backfill to a Pub/Sub topic.
+ */
+export declare class PubSubBackfillEventPublisher extends BackfillEventPublisher {
+    readonly topicId: string;
+    /**
+     * The actual publisher, which handles batching and flow control.
+     */
+    private readonly publisher;
+    /**
+     * Creates a new {@link PubSubBackfillEventPublisher}.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param topicId The ID of the Pub/Sub topic to publish to.
+     *   This should be a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+     */
+    constructor(context: WorkspaceContext, topicId: string);
+    /**
+     * Publishes an event to the Pub/Sub topic.
+     * Publishing actually occurs asynchronously. {@link PubSubBackfillEventPublisher.flush} must be called to wait for
+     * all events to be published.
+     *
+     * @param event The event to publish.
+     * @returns A promise that resolves when the publisher has caught up with publishing, or `null` if other events can be
+     *   published immediately.
+     */
+    protected publishEvent(event: BackfillEvent): Promise<void> | null;
+    /**
+     * Waits for all events to be published.
+     */
+    protected flush(): Promise<void>;
+}

package/dist/backfilling/pubsub.js

@@ -0,0 +1,63 @@
+import { BackfillEventPublisher } from '@causa/workspace-core';
+import { PubSubService } from '../services/index.js';
+/**
+ * Options when publishing events in batches to Pub/Sub.
+ */
+const PUBLISH_OPTIONS = {
+    flowControlOptions: {
+        maxOutstandingBytes: 512 * 1024 * 1024,
+        maxOutstandingMessages: 100000,
+    },
+    batching: {
+        maxBytes: 10 * 1024 * 1024,
+        maxMessages: 1000,
+        maxMilliseconds: 1000,
+    },
+};
+/**
+ * A publisher that publishes events to backfill to a Pub/Sub topic.
+ */
+export class PubSubBackfillEventPublisher extends BackfillEventPublisher {
+    topicId;
+    /**
+     * The actual publisher, which handles batching and flow control.
+     */
+    publisher;
+    /**
+     * Creates a new {@link PubSubBackfillEventPublisher}.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @param topicId The ID of the Pub/Sub topic to publish to.
+     *   This should be a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+     */
+    constructor(context, topicId) {
+        super(context);
+        this.topicId = topicId;
+        this.publisher = context
+            .service(PubSubService)
+            .pubSub.topic(topicId, PUBLISH_OPTIONS)
+            .flowControlled();
+    }
+    /**
+     * Publishes an event to the Pub/Sub topic.
+     * Publishing actually occurs asynchronously. {@link PubSubBackfillEventPublisher.flush} must be called to wait for
+     * all events to be published.
+     *
+     * @param event The event to publish.
+     * @returns A promise that resolves when the publisher has caught up with publishing, or `null` if other events can be
+     *   published immediately.
+     */
+    publishEvent(event) {
+        return this.publisher.publish({
+            data: event.data,
+            attributes: event.attributes,
+            orderingKey: event.key,
+        });
+    }
+    /**
+     * Waits for all events to be published.
+     */
+    async flush() {
+        await this.publisher.all();
+    }
+}

package/dist/configurations/google.d.ts

@@ -10,6 +10,10 @@ export type GoogleConfiguration = {
          * The ID of the default GCP project used when performing operations.
          */
         readonly project?: string;
+        /**
+         * The GCP region in which resource should be created and managed.
+         */
+        readonly region?: string;
         /**
          * The ID of a local GCP project (which does not exist on GCP).
          * This is for example used by emulators. It should usually start with `demo-` to be compatible with some emulators.
@@ -153,6 +157,24 @@ export type GoogleConfiguration = {
                  */
                 readonly containerName?: string;
             };
+            /**
+             * The directory where the topic configuration files are written by the `GooglePubSubWriteTopics` processor.
+             */
+            readonly topicConfigurationsDirectory?: string;
+            /**
+             * Configuration for the storage of Pub/Sub events in BigQuery.
+             */
+            readonly bigQueryStorage?: {
+                /**
+                 * The ID of the BigQuery dataset where raw Pub/Sub events should be stored.
+                 */
+                readonly rawEventsDatasetId?: string;
+                /**
+                 * The BigQuery location for the datasets.
+                 * See https://cloud.google.com/bigquery/docs/locations for more details.
+                 */
+                readonly location?: string;
+            };
         };
         /**
          * Configuration for the Spanner service.
@@ -175,6 +197,25 @@ export type GoogleConfiguration = {
                  */
                 readonly instanceName?: string;
             };
+            /**
+             * Configuration for the Spanner instance.
+             */
+            readonly instance?: {
+                /**
+                 * The name of the Spanner instance.
+                 */
+                readonly name?: string;
+                /**
+                 * The instance geographic configuration.
+                 * See https://cloud.google.com/spanner/docs/instance-configurations for more details.
+                 */
+                readonly configuration?: string;
+                /**
+                 * The compute capacity of the instance.
+                 * See https://cloud.google.com/spanner/docs/compute-capacity for more details.
+                 */
+                readonly processingUnits?: number;
+            };
             /**
              * Defines how DDLs are found for the Spanner databases in the workspace.
              */
@@ -192,6 +233,11 @@ export type GoogleConfiguration = {
                  */
                 readonly regularExpression?: string;
             };
+            /**
+             * The directory where the database configuration files are written by the `GoogleSpannerWriteDatabases`
+             * processor.
+             */
+            readonly databaseConfigurationsDirectory?: string;
         };
         /**
          * Configuration for Cloud Functions.
@@ -210,6 +256,41 @@ export type GoogleConfiguration = {
              * The Docker repository where Cloud Run containers should be uploaded.
              */
             readonly dockerRepository?: string;
+            /**
+             * The location where Cloud Run services should be deployed.
+             */
+            readonly location?: string;
+            /**
+             * A map where keys are the name of environment variables, and values are secret versions IDs (e.g.
+             * `projects/my-project/secrets/my-secret/versions/1`).
+             */
+            readonly secretEnvironmentVariables?: Record<string, string>;
+            /**
+             * Whether the container is running between requests and can perform background operations.
+             */
+            readonly cpuAlwaysAllocated?: boolean;
+            /**
+             * The max duration the instance is allowed for responding to a request, in seconds.
+             */
+            readonly timeout?: number;
+            /**
+             * The maximum allowed in-flight (concurrent) requests per container.
+             */
+            readonly requestConcurrency?: number;
+            /**
+             * The type of allowed ingress that can reach the container.
+             * See https://cloud.google.com/run/docs/securing/ingress#settings for more details.
+             */
+            readonly ingress?: 'all' | 'internal' | 'internal-and-cloud-load-balancing';
+            /**
+             * The name of the VPC access connector through which egress traffic should be routed.
+             */
+            readonly vpcAccessConnector?: string;
+            /**
+             * The setting for egress traffic that goes through the VPC access connector.
+             * See https://cloud.google.com/run/docs/configuring/connecting-vpc#manage for more details.
+             */
+            readonly vpcAccessConnectorEgressSettings?: 'all-traffic' | 'private-ranges-only';
         };
     };
 };

package/dist/functions/emulator/index.d.ts

@@ -0,0 +1,10 @@
+export { EmulatorStartForFirebaseStorage } from './start-firebase-storage.js';
+export { EmulatorStartForFirestore } from './start-firestore.js';
+export { EmulatorStartForIdentityPlatform } from './start-identity-platform.js';
+export { EmulatorStartForPubSub } from './start-pubsub.js';
+export { EmulatorStartForSpanner } from './start-spanner.js';
+export { EmulatorStopForFirebaseStorage } from './stop-firebase-storage.js';
+export { EmulatorStopForFirestore } from './stop-firestore.js';
+export { EmulatorStopForIdentityPlatform } from './stop-identity-platform.js';
+export { EmulatorStopForPubSub } from './stop-pubsub.js';
+export { EmulatorStopForSpanner } from './stop-spanner.js';

package/dist/functions/emulator/index.js

@@ -0,0 +1,10 @@
+export { EmulatorStartForFirebaseStorage } from './start-firebase-storage.js';
+export { EmulatorStartForFirestore } from './start-firestore.js';
+export { EmulatorStartForIdentityPlatform } from './start-identity-platform.js';
+export { EmulatorStartForPubSub } from './start-pubsub.js';
+export { EmulatorStartForSpanner } from './start-spanner.js';
+export { EmulatorStopForFirebaseStorage } from './stop-firebase-storage.js';
+export { EmulatorStopForFirestore } from './stop-firestore.js';
+export { EmulatorStopForIdentityPlatform } from './stop-identity-platform.js';
+export { EmulatorStopForPubSub } from './stop-pubsub.js';
+export { EmulatorStopForSpanner } from './stop-spanner.js';

package/dist/functions/{emulator-start-firebase-storage.js → emulator/start-firebase-storage.js}

@@ -1,12 +1,12 @@
 import { EmulatorStart } from '@causa/workspace-core';
 import { fileURLToPath } from 'url';
-import { FIREBASE_CONTAINER_STORAGE_RULES_FILE, FIREBASE_STORAGE_EMULATOR_NAME, FIREBASE_STORAGE_PORT, getFirebaseStorageContainerName, } from '../emulators/index.js';
-import { FirebaseEmulatorService } from '../services/index.js';
-import { GoogleFirebaseStorageMergeRules } from './google-firebase-storage-merge-rules.js';
+import { FIREBASE_CONTAINER_STORAGE_RULES_FILE, FIREBASE_STORAGE_EMULATOR_NAME, FIREBASE_STORAGE_PORT, getFirebaseStorageContainerName, } from '../../emulators/index.js';
+import { FirebaseEmulatorService } from '../../services/index.js';
+import { GoogleFirebaseStorageMergeRules } from '../google-firebase-storage/index.js';
 /**
  * The Firebase configuration file enabling only the Storage emulator.
  */
-const FIREBASE_CONF_FILE = fileURLToPath(new URL('../assets/firebase-storage.json', import.meta.url));
+const FIREBASE_CONF_FILE = fileURLToPath(new URL('../../assets/firebase-storage.json', import.meta.url));
 /**
  * Implements {@link EmulatorStart} for the Firebase Storage container.
  * This first merges the Firebase Storage security rules into a single file, and uses this file to configure the

package/dist/functions/{emulator-start-firestore.js → emulator/start-firestore.js}

@@ -1,7 +1,7 @@
 import { EmulatorStart } from '@causa/workspace-core';
-import { FIRESTORE_CONTAINER_RULES_FILE, FIRESTORE_EMULATOR_NAME, FIRESTORE_PORT, getFirestoreContainerName, } from '../emulators/index.js';
-import { GcloudEmulatorService } from '../index.js';
-import { GoogleFirestoreMergeRules } from './google-firestore-merge-rules.js';
+import { FIRESTORE_CONTAINER_RULES_FILE, FIRESTORE_EMULATOR_NAME, FIRESTORE_PORT, getFirestoreContainerName, } from '../../emulators/index.js';
+import { GcloudEmulatorService } from '../../services/index.js';
+import { GoogleFirestoreMergeRules } from '../google-firestore/index.js';
 /**
  * Implements {@link EmulatorStart} for the Firestore emulator.
  * This first merges the Firestore security rules into a single file, and uses this file to configure the emulator.

package/dist/functions/{emulator-start-identity-platform.js → emulator/start-identity-platform.js}

@@ -1,11 +1,11 @@
 import { EmulatorStart } from '@causa/workspace-core';
 import { fileURLToPath } from 'url';
-import { FIREBASE_AUTH_PORT, IDENTITY_PLATFORM_EMULATOR_NAME, getIdentityPlatformContainerName, } from '../emulators/index.js';
-import { FirebaseEmulatorService } from '../services/index.js';
+import { FIREBASE_AUTH_PORT, IDENTITY_PLATFORM_EMULATOR_NAME, getIdentityPlatformContainerName, } from '../../emulators/index.js';
+import { FirebaseEmulatorService } from '../../services/index.js';
 /**
  * The Firebase configuration file enabling only the Auth emulator.
  */
-const FIREBASE_CONF_FILE = fileURLToPath(new URL('../assets/firebase-auth.json', import.meta.url));
+const FIREBASE_CONF_FILE = fileURLToPath(new URL('../../assets/firebase-auth.json', import.meta.url));
 /**
  * Implements {@link EmulatorStart} for the Identity Platform emulator.
  * This actually runs the "legacy" Firebase Auth emulator, which is the same service before it was re-branded.

package/dist/functions/{emulator-start-pubsub.js → emulator/start-pubsub.js}

@@ -1,8 +1,8 @@
 import { EmulatorStart, EventTopicList, } from '@causa/workspace-core';
 import { PubSub } from '@google-cloud/pubsub';
-import { getLocalGcpProject } from '../configurations/utils.js';
-import { PUBSUB_EMULATOR_NAME, PUBSUB_PORT, formatPubSubTopicAsEnvironmentVariable, getPubSubContainerName, } from '../emulators/index.js';
-import { GcloudEmulatorService } from '../index.js';
+import { getLocalGcpProject } from '../../configurations/utils.js';
+import { PUBSUB_EMULATOR_NAME, PUBSUB_PORT, formatPubSubTopicAsEnvironmentVariable, getPubSubContainerName, } from '../../emulators/index.js';
+import { GcloudEmulatorService } from '../../services/index.js';
 /**
  * Implements {@link EmulatorStart} for the Pub/Sub emulator.
  * This first starts the Pub/Sub emulator, and then creates the topics defined in the workspace (if the workspace is

package/dist/functions/{emulator-start-spanner.js → emulator/start-spanner.js}

@@ -1,9 +1,9 @@
 import { DockerEmulatorService, EmulatorStart, } from '@causa/workspace-core';
 import { Spanner } from '@google-cloud/spanner';
-import { grpc } from 'google-gax';
-import { getLocalGcpProject, } from '../configurations/index.js';
-import { SPANNER_EMULATOR_NAME, SPANNER_GRPC_PORT, SPANNER_HTTP_PORT, SPANNER_IMAGE, getSpannerContainerName, } from '../emulators/index.js';
-import { GoogleSpannerListDatabases } from './google-spanner-list-databases.js';
+import { credentials } from '@grpc/grpc-js';
+import { getLocalGcpProject, } from '../../configurations/index.js';
+import { SPANNER_EMULATOR_NAME, SPANNER_GRPC_PORT, SPANNER_HTTP_PORT, SPANNER_IMAGE, getSpannerContainerName, } from '../../emulators/index.js';
+import { GoogleSpannerListDatabases } from '../google-spanner/index.js';
 /**
  * Implements {@link EmulatorStart} for the Spanner emulator.
  * This starts the emulator, creates a local instance, and creates the databases using the DDLs found in the workspace.
@@ -75,7 +75,7 @@ export class EmulatorStartForSpanner extends EmulatorStart {
             servicePath: '127.0.0.1',
             port: SPANNER_GRPC_PORT,
             projectId: getLocalGcpProject(context),
-            sslCreds: grpc.credentials.createInsecure(),
+            sslCreds: credentials.createInsecure(),
         });
         const [instance, operation] = await spanner.createInstance(instanceName, {
             config: 'emulator-config',

package/dist/functions/{emulator-stop-firebase-storage.js → emulator/stop-firebase-storage.js}

@@ -1,5 +1,5 @@
 import { DockerEmulatorService, EmulatorStop } from '@causa/workspace-core';
-import { FIREBASE_STORAGE_EMULATOR_NAME, getFirebaseStorageContainerName, } from '../emulators/index.js';
+import { FIREBASE_STORAGE_EMULATOR_NAME, getFirebaseStorageContainerName, } from '../../emulators/index.js';
 /**
  * Implements {@link EmulatorStop} for the Firebase Storage emulator.
  */

package/dist/functions/{emulator-stop-firestore.js → emulator/stop-firestore.js}

@@ -1,5 +1,5 @@
 import { DockerEmulatorService, EmulatorStop } from '@causa/workspace-core';
-import { FIRESTORE_EMULATOR_NAME, getFirestoreContainerName, } from '../emulators/index.js';
+import { FIRESTORE_EMULATOR_NAME, getFirestoreContainerName, } from '../../emulators/index.js';
 /**
  * Implements {@link EmulatorStop} for the Firestore emulator.
  */

package/dist/functions/{emulator-stop-identity-platform.js → emulator/stop-identity-platform.js}

@@ -1,5 +1,5 @@
 import { DockerEmulatorService, EmulatorStop } from '@causa/workspace-core';
-import { IDENTITY_PLATFORM_EMULATOR_NAME, getIdentityPlatformContainerName, } from '../emulators/index.js';
+import { IDENTITY_PLATFORM_EMULATOR_NAME, getIdentityPlatformContainerName, } from '../../emulators/index.js';
 /**
  * Implements {@link EmulatorStop} for the Identity Platform emulator.
  */

package/dist/functions/{emulator-stop-pubsub.js → emulator/stop-pubsub.js}

@@ -1,5 +1,5 @@
 import { DockerEmulatorService, EmulatorStop } from '@causa/workspace-core';
-import { PUBSUB_EMULATOR_NAME, getPubSubContainerName, } from '../emulators/index.js';
+import { PUBSUB_EMULATOR_NAME, getPubSubContainerName, } from '../../emulators/index.js';
 /**
  * Implements {@link EmulatorStop} for the Pub/Sub emulator.
  */

package/dist/functions/{emulator-stop-spanner.js → emulator/stop-spanner.js}

@@ -1,5 +1,5 @@
 import { DockerEmulatorService, EmulatorStop } from '@causa/workspace-core';
-import { SPANNER_EMULATOR_NAME, getSpannerContainerName, } from '../emulators/index.js';
+import { SPANNER_EMULATOR_NAME, getSpannerContainerName, } from '../../emulators/index.js';
 /**
  * Implements {@link EmulatorStop} for the Spanner emulator.
  */

package/dist/functions/event-topic/broker-create-topic-pubsub.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerCreateTopic } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerCreateTopic} for Pub/Sub.
+ * Topics are created in the GCP project set in the `google.project` configuration.
+ * If a `google.region` configuration is set, the message storage policy for the topic is set accordingly.
+ */
+export declare class EventTopicBrokerCreateTopicForPubSub extends EventTopicBrokerCreateTopic {
+    _call(context: WorkspaceContext): Promise<string>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-create-topic-pubsub.js

@@ -0,0 +1,27 @@
+import { EventTopicBrokerCreateTopic, } from '@causa/workspace-core';
+import { PubSubService } from '../../services/index.js';
+/**
+ * Implements {@link EventTopicBrokerCreateTopic} for Pub/Sub.
+ * Topics are created in the GCP project set in the `google.project` configuration.
+ * If a `google.region` configuration is set, the message storage policy for the topic is set accordingly.
+ */
+export class EventTopicBrokerCreateTopicForPubSub extends EventTopicBrokerCreateTopic {
+    async _call(context) {
+        const googleConf = context.asConfiguration();
+        const projectId = googleConf.getOrThrow('google.project');
+        const region = googleConf.get('google.region');
+        const topicId = `projects/${projectId}/topics/${this.name}`;
+        context.logger.info(`📫 Creating Pub/Sub topic '${topicId}'.`);
+        await context.service(PubSubService).pubSub.createTopic({
+            name: topicId,
+            ...(region
+                ? { messageStoragePolicy: { allowedPersistenceRegions: [region] } }
+                : {}),
+        });
+        return topicId;
+    }
+    _supports(context) {
+        return (context.asConfiguration().get('events.broker') ===
+            'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-create-trigger-cloud-run.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerCreateTrigger } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerCreateTrigger} for Cloud Run endpoints being triggered by Pub/Sub messages.
+ * The `id` argument should be a Cloud Run service ID, followed by the path to the trigger, e.g.
+ * `[[projects/<projectId>/]locations/<location>/]services/<name>/path-to-trigger`.
+ */
+export declare class EventTopicBrokerCreateTriggerForCloudRun extends EventTopicBrokerCreateTrigger {
+    _call(context: WorkspaceContext): Promise<string[]>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-create-trigger-cloud-run.js

@@ -0,0 +1,38 @@
+import { EventTopicBrokerCreateTrigger, } from '@causa/workspace-core';
+import { CloudRunPubSubTriggerService } from '../../services/index.js';
+/**
+ * The regular expression used to match Cloud Run trigger IDs, consisting of the service ID and the path to the trigger.
+ * [[projects/<projectId>/]locations/<location>/]services/<name>/path-to-trigger
+ */
+const CLOUD_RUN_TRIGGER_ID_REGEX = /^(?:(?:projects\/(?<projectId>[\w-]+)\/)?locations\/(?<location>[\w-]+)\/)?services\/(?<name>[\w-]+)(?<path>\/.*)$/;
+/**
+ * Implements {@link EventTopicBrokerCreateTrigger} for Cloud Run endpoints being triggered by Pub/Sub messages.
+ * The `id` argument should be a Cloud Run service ID, followed by the path to the trigger, e.g.
+ * `[[projects/<projectId>/]locations/<location>/]services/<name>/path-to-trigger`.
+ */
+export class EventTopicBrokerCreateTriggerForCloudRun extends EventTopicBrokerCreateTrigger {
+    async _call(context) {
+        const match = this.trigger.match(CLOUD_RUN_TRIGGER_ID_REGEX);
+        if (!match?.groups) {
+            throw new Error('Oops.');
+        }
+        const googleConf = context.asConfiguration();
+        const projectId = match.groups.projectId ?? googleConf.getOrThrow('google.project');
+        const location = match.groups.location ??
+            googleConf.getOrThrow('google.cloudRun.location');
+        const name = match.groups.name;
+        const path = match.groups.path;
+        if (!name || !path) {
+            throw new Error('Oops.');
+        }
+        const serviceId = `projects/${projectId}/locations/${location}/services/${name}`;
+        return await context
+            .service(CloudRunPubSubTriggerService)
+            .create(this.backfillId, this.topicId, serviceId, path);
+    }
+    _supports(context) {
+        return (this.trigger.match(CLOUD_RUN_TRIGGER_ID_REGEX) != null &&
+            context.asConfiguration().get('events.broker') ===
+                'google.pubSub');
+    }
+}