@causa/workspace-google 0.16.0 → 0.18.0-beta.1

package/dist/functions/project/get-artefact-destination-cloud-run.js

@@ -1,19 +1,18 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { ProjectGetArtefactDestination, } from '@causa/workspace-core';
 /**
  * Implements the {@link ProjectGetArtefactDestination} function for Cloud Run services.
  * The destination Docker repository is expected to be defined in `google.cloudRun.dockerRepository`.
  */
 export class ProjectGetArtefactDestinationForCloudRun extends ProjectGetArtefactDestination {
-    async _call(context) {
-        const projectName = context.getOrThrow('project.name');
-        const dockerRepository = context
+    async _call() {
+        const projectName = this._context.getOrThrow('project.name');
+        const dockerRepository = this._context
             .asConfiguration()
             .getOrThrow('google.cloudRun.dockerRepository');
         return `${dockerRepository}/${projectName}:${this.tag}`;
     }
-    _supports(context) {
-        const conf = context.asConfiguration();
+    _supports() {
+        const conf = this._context.asConfiguration();
         return (conf.get('project.type') === 'serviceContainer' &&
             conf.get('serviceContainer.platform') === 'google.cloudRun');
     }

package/dist/functions/project/push-artefact-cloud-functions.call.d.ts

@@ -1,3 +1,2 @@
-import type { WorkspaceContext } from '@causa/workspace';
 import type { ProjectPushArtefactForCloudFunctions } from './push-artefact-cloud-functions.js';
-export default function call(this: ProjectPushArtefactForCloudFunctions, context: WorkspaceContext): Promise<string>;
+export default function call(this: ProjectPushArtefactForCloudFunctions): Promise<string>;

package/dist/functions/project/push-artefact-cloud-functions.call.js

@@ -1,9 +1,9 @@
 import { ArtefactAlreadyExistsError } from '@causa/workspace-core';
 import { rm } from 'fs/promises';
 import { CloudStorageService } from '../../services/storage.js';
-export default async function call(context) {
-    context.logger.info(`🚚 Pushing Cloud Functions archive to Cloud Storage.`);
-    const storageService = context.service(CloudStorageService);
+export default async function call() {
+    this._context.logger.info(`🚚 Pushing Cloud Functions archive to Cloud Storage.`);
+    const storageService = this._context.service(CloudStorageService);
     const destination = storageService.getFileFromGsUri(this.destination);
     if (!this.overwrite) {
         const [exists] = await destination.exists();
@@ -12,8 +12,8 @@ export default async function call(context) {
         }
     }
     await destination.bucket.upload(this.artefact, { destination });
-    context.logger.info(`🚚 Successfully pushed archive to '${this.destination}'.`);
-    context.logger.debug(`🔥 Removing local artefact '${this.artefact}'.`);
+    this._context.logger.info(`🚚 Successfully pushed archive to '${this.destination}'.`);
+    this._context.logger.debug(`🔥 Removing local artefact '${this.artefact}'.`);
     await rm(this.artefact);
     return this.destination;
 }

package/dist/functions/project/push-artefact-cloud-functions.d.ts

@@ -1,4 +1,3 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { ProjectPushArtefact } from '@causa/workspace-core';
 /**
  * Implements the {@link ProjectPushArtefact} function for Cloud Functions projects.
@@ -6,6 +5,6 @@ import { ProjectPushArtefact } from '@causa/workspace-core';
  * {@link ProjectPushArtefact.destination}.
  */
 export declare class ProjectPushArtefactForCloudFunctions extends ProjectPushArtefact {
-    _call(context: WorkspaceContext): Promise<string>;
-    _supports(context: WorkspaceContext): boolean;
+    _call(): Promise<string>;
+    _supports(): boolean;
 }

package/dist/functions/project/push-artefact-cloud-functions.js

@@ -1,4 +1,4 @@
-import { callDeferred, WorkspaceContext } from '@causa/workspace';
+import { callDeferred } from '@causa/workspace';
 import { ProjectPushArtefact, } from '@causa/workspace-core';
 /**
  * Implements the {@link ProjectPushArtefact} function for Cloud Functions projects.
@@ -6,11 +6,11 @@ import { ProjectPushArtefact, } from '@causa/workspace-core';
  * {@link ProjectPushArtefact.destination}.
  */
 export class ProjectPushArtefactForCloudFunctions extends ProjectPushArtefact {
-    async _call(context) {
-        return await callDeferred(this, context, import.meta.url);
+    async _call() {
+        return await callDeferred(this, import.meta.url);
     }
-    _supports(context) {
-        const conf = context.asConfiguration();
+    _supports() {
+        const conf = this._context.asConfiguration();
         return (conf.get('project.type') === 'serverlessFunctions' &&
             conf.get('serverlessFunctions.platform') === 'google.cloudFunctions');
     }

package/dist/functions/secret/fetch-access-token.call.d.ts

@@ -1,3 +1,2 @@
-import type { WorkspaceContext } from '@causa/workspace';
 import { type SecretFetchForGoogleAccessToken } from './fetch-access-token.js';
-export default function call(this: SecretFetchForGoogleAccessToken, context: WorkspaceContext): Promise<string>;
+export default function call(this: SecretFetchForGoogleAccessToken): Promise<string>;

package/dist/functions/secret/fetch-access-token.call.js

@@ -1,7 +1,9 @@
 import { GoogleApisService } from '../../services/google-apis.js';
 import { AuthClientResponseError, } from './fetch-access-token.js';
-export default async function call(context) {
-    const authClient = await context.service(GoogleApisService).getAuthClient();
+export default async function call() {
+    const authClient = await this._context
+        .service(GoogleApisService)
+        .getAuthClient();
     const { token } = await authClient.getAccessToken();
     if (!token) {
         throw new AuthClientResponseError();

package/dist/functions/secret/fetch-access-token.d.ts

@@ -1,4 +1,4 @@
-import { SecretFetch, WorkspaceContext } from '@causa/workspace';
+import { SecretFetch } from '@causa/workspace';
 /**
  * An error thrown when the auth client does not return a token.
  */
@@ -13,6 +13,6 @@ export declare class AuthClientResponseError extends Error {
  * The backend ID is `google.accessToken`.
  */
 export declare class SecretFetchForGoogleAccessToken extends SecretFetch {
-    _call(context: WorkspaceContext): Promise<string>;
+    _call(): Promise<string>;
     _supports(): boolean;
 }

package/dist/functions/secret/fetch-access-token.js

@@ -1,4 +1,4 @@
-import { callDeferred, SecretFetch, WorkspaceContext } from '@causa/workspace';
+import { callDeferred, SecretFetch } from '@causa/workspace';
 /**
  * An error thrown when the auth client does not return a token.
  */
@@ -15,8 +15,8 @@ export class AuthClientResponseError extends Error {
  * The backend ID is `google.accessToken`.
  */
 export class SecretFetchForGoogleAccessToken extends SecretFetch {
-    async _call(context) {
-        return await callDeferred(this, context, import.meta.url);
+    async _call() {
+        return await callDeferred(this, import.meta.url);
     }
     _supports() {
         return this.backend === 'google.accessToken';

package/dist/functions/secret/fetch-secret-manager.call.d.ts

@@ -1,3 +1,2 @@
-import { type WorkspaceContext } from '@causa/workspace';
 import { type SecretFetchForGoogleSecretManager } from './fetch-secret-manager.js';
-export default function call(this: SecretFetchForGoogleSecretManager, context: WorkspaceContext): Promise<string>;
+export default function call(this: SecretFetchForGoogleSecretManager): Promise<string>;

package/dist/functions/secret/fetch-secret-manager.call.js

@@ -1,4 +1,4 @@
-import { InvalidSecretDefinitionError, } from '@causa/workspace';
+import { InvalidSecretDefinitionError } from '@causa/workspace';
 import { GoogleSecretManagerService } from '../../services/secret-manager.js';
 import { UndefinedDefaultGcpProjectError, UnexpectedSecretValueError, } from './fetch-secret-manager.js';
 /**
@@ -6,7 +6,7 @@ import { UndefinedDefaultGcpProjectError, UnexpectedSecretValueError, } from './
  * [projects/<projectId>/secrets]<secretName>[/versions/<version>]
  */
 const SECRET_ID_REGEX = /^(?:projects\/(?<projectId>[\w-]+)\/secrets\/)?(?<secretName>[\w-]+)(?:\/versions\/(?<version>(\d+|latest)))?$/;
-export default async function call(context) {
+export default async function call() {
     const id = this.configuration.id;
     if (!id) {
         throw new InvalidSecretDefinitionError(`Missing 'id' field that should reference the secret.`);
@@ -16,7 +16,7 @@ export default async function call(context) {
     if (!secretName) {
         throw new InvalidSecretDefinitionError(`Failed to parse secret reference '${id}'.`);
     }
-    const { client, defaultProject } = context.service(GoogleSecretManagerService);
+    const { client, defaultProject } = this._context.service(GoogleSecretManagerService);
     const project = match?.groups?.projectId ?? defaultProject;
     const version = match?.groups?.version ?? 'latest';
     if (!project) {

package/dist/functions/secret/fetch-secret-manager.d.ts

@@ -1,4 +1,4 @@
-import { SecretFetch, WorkspaceContext } from '@causa/workspace';
+import { SecretFetch } from '@causa/workspace';
 /**
  * An error thrown when the default GCP project is needed to look up a secret but it has not been defined.
  */
@@ -28,6 +28,6 @@ export declare class UnexpectedSecretValueError extends Error {
  * `google.project`.
  */
 export declare class SecretFetchForGoogleSecretManager extends SecretFetch {
-    _call(context: WorkspaceContext): Promise<string>;
+    _call(): Promise<string>;
     _supports(): boolean;
 }

package/dist/functions/secret/fetch-secret-manager.js

@@ -1,4 +1,4 @@
-import { callDeferred, SecretFetch, WorkspaceContext } from '@causa/workspace';
+import { callDeferred, SecretFetch } from '@causa/workspace';
 /**
  * An error thrown when the default GCP project is needed to look up a secret but it has not been defined.
  */
@@ -32,8 +32,8 @@ export class UnexpectedSecretValueError extends Error {
  * `google.project`.
  */
 export class SecretFetchForGoogleSecretManager extends SecretFetch {
-    async _call(context) {
-        return await callDeferred(this, context, import.meta.url);
+    async _call() {
+        return await callDeferred(this, import.meta.url);
     }
     _supports() {
         return this.backend === 'google.secretManager';

package/dist/functions/service-container/index.d.ts

@@ -0,0 +1 @@
+export { ServiceContainerQueryLogsForCloudRun } from './query-logs-cloud-run.js';

package/dist/functions/service-container/index.js

@@ -0,0 +1 @@
+export { ServiceContainerQueryLogsForCloudRun } from './query-logs-cloud-run.js';

package/dist/functions/service-container/query-logs-cloud-run.call.d.ts

@@ -0,0 +1,3 @@
+import type { QueriedLogEntry } from '@causa/workspace-core';
+import type { ServiceContainerQueryLogsForCloudRun } from './query-logs-cloud-run.js';
+export default function call(this: ServiceContainerQueryLogsForCloudRun): Promise<QueriedLogEntry[]>;

package/dist/functions/service-container/query-logs-cloud-run.call.js

@@ -0,0 +1,36 @@
+import { LoggingService } from '../../services/index.js';
+/**
+ * The default duration applied to `from` when it is not set, in milliseconds.
+ */
+const DEFAULT_FROM_OFFSET = 60 * 60 * 1000;
+/**
+ * The default value for `limit` when it is not set.
+ */
+const DEFAULT_LIMIT = 1000;
+export default async function call() {
+    const from = this.from ?? new Date(Date.now() - DEFAULT_FROM_OFFSET);
+    const limit = this.limit ?? DEFAULT_LIMIT;
+    const filterParts = [
+        `resource.type="cloud_run_revision"`,
+        `resource.labels.service_name=~"${this.service}"`,
+        `timestamp>="${from.toISOString()}"`,
+    ];
+    if (this.to) {
+        filterParts.push(`timestamp<"${this.to.toISOString()}"`);
+    }
+    if (this.filter) {
+        filterParts.push(this.filter);
+    }
+    const filter = filterParts.join('\n');
+    const loggingService = this._context.service(LoggingService);
+    this._context.logger.debug(`Querying Cloud Logging for service '${this.service}' in project '${loggingService.projectId}' with filter:\n${filter}`);
+    const [pageEntries] = await loggingService.logging.getEntries({
+        filter,
+        orderBy: 'timestamp asc',
+        maxResults: limit,
+    });
+    return pageEntries.map((entry) => ({
+        timestamp: entry.metadata.timestamp,
+        message: entry.toStructuredJSON(),
+    }));
+}

package/dist/functions/service-container/query-logs-cloud-run.d.ts

@@ -0,0 +1,11 @@
+import { type QueriedLogEntry, ServiceContainerQueryLogs } from '@causa/workspace-core';
+/**
+ * Implements {@link ServiceContainerQueryLogs} for services deployed on Cloud Run.
+ *
+ * Queries the Cloud Logging API for entries emitted by `cloud_run_revision` resources whose `service_name` label
+ * matches the input `service`. The optional `from` / `to` time range, `filter`, and `limit` are forwarded to the API.
+ */
+export declare class ServiceContainerQueryLogsForCloudRun extends ServiceContainerQueryLogs {
+    _call(): Promise<QueriedLogEntry[]>;
+    _supports(): boolean;
+}

package/dist/functions/service-container/query-logs-cloud-run.js

@@ -0,0 +1,18 @@
+import { callDeferred } from '@causa/workspace';
+import { ServiceContainerQueryLogs, } from '@causa/workspace-core';
+/**
+ * Implements {@link ServiceContainerQueryLogs} for services deployed on Cloud Run.
+ *
+ * Queries the Cloud Logging API for entries emitted by `cloud_run_revision` resources whose `service_name` label
+ * matches the input `service`. The optional `from` / `to` time range, `filter`, and `limit` are forwarded to the API.
+ */
+export class ServiceContainerQueryLogsForCloudRun extends ServiceContainerQueryLogs {
+    async _call() {
+        return await callDeferred(this, import.meta.url);
+    }
+    _supports() {
+        return (this._context
+            .asConfiguration()
+            .get('serviceContainer.platform') === 'google.cloudRun');
+    }
+}

package/dist/functions/typescript/get-decorator-renderer-google-firestore.d.ts

@@ -1,9 +1,8 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { TypeScriptGetDecoratorRenderer, type TypeScriptWithDecoratorsRendererType } from '@causa/workspace-typescript';
 /**
  * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleFirestoreRenderer`.
  */
 export declare class TypeScriptGetDecoratorRendererForGoogleFirestore extends TypeScriptGetDecoratorRenderer {
     _call(): Promise<TypeScriptWithDecoratorsRendererType>;
-    _supports(context: WorkspaceContext): boolean;
+    _supports(): boolean;
 }

package/dist/functions/typescript/get-decorator-renderer-google-firestore.js

@@ -1,4 +1,3 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { TypeScriptGetDecoratorRenderer, } from '@causa/workspace-typescript';
 /**
  * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleFirestoreRenderer`.
@@ -8,8 +7,8 @@ export class TypeScriptGetDecoratorRendererForGoogleFirestore extends TypeScript
         const { GoogleFirestoreRenderer } = await import('../../code-generation/index.js');
         return GoogleFirestoreRenderer;
     }
-    _supports(context) {
-        return (context.get('project.language') === 'typescript' &&
+    _supports() {
+        return (this._context.get('project.language') === 'typescript' &&
             this.generator === 'typescriptModelClass');
     }
 }

package/dist/functions/typescript/get-decorator-renderer-google-spanner.d.ts

@@ -1,9 +1,8 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { TypeScriptGetDecoratorRenderer, type TypeScriptWithDecoratorsRendererType } from '@causa/workspace-typescript';
 /**
  * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleSpannerRenderer`.
  */
 export declare class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGetDecoratorRenderer {
     _call(): Promise<TypeScriptWithDecoratorsRendererType>;
-    _supports(context: WorkspaceContext): boolean;
+    _supports(): boolean;
 }

package/dist/functions/typescript/get-decorator-renderer-google-spanner.js

@@ -1,4 +1,3 @@
-import { WorkspaceContext } from '@causa/workspace';
 import { TypeScriptGetDecoratorRenderer, } from '@causa/workspace-typescript';
 /**
  * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleSpannerRenderer`.
@@ -8,8 +7,8 @@ export class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGe
         const { GoogleSpannerRenderer } = await import('../../code-generation/index.js');
         return GoogleSpannerRenderer;
     }
-    _supports(context) {
-        return (context.get('project.language') === 'typescript' &&
+    _supports() {
+        return (this._context.get('project.language') === 'typescript' &&
             this.generator === 'typescriptModelClass');
     }
 }

package/dist/services/index.d.ts

@@ -8,6 +8,7 @@ export { FirebaseEmulatorService } from './firebase-emulator.js';
 export { GcloudEmulatorService } from './gcloud-emulator.js';
 export { GoogleApisService } from './google-apis.js';
 export { IamService } from './iam.js';
+export { LoggingService } from './logging.js';
 export { PubSubService } from './pubsub.js';
 export { ResourceManagerService } from './resource-manager.js';
 export { GoogleSecretManagerService } from './secret-manager.js';

package/dist/services/index.js

@@ -7,6 +7,7 @@ export { FirebaseEmulatorService } from './firebase-emulator.js';
 export { GcloudEmulatorService } from './gcloud-emulator.js';
 export { GoogleApisService } from './google-apis.js';
 export { IamService } from './iam.js';
+export { LoggingService } from './logging.js';
 export { PubSubService } from './pubsub.js';
 export { ResourceManagerService } from './resource-manager.js';
 export { GoogleSecretManagerService } from './secret-manager.js';

package/dist/services/logging.d.ts

@@ -0,0 +1,16 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { Logging } from '@google-cloud/logging';
+/**
+ * A service that provides access to Cloud Logging.
+ */
+export declare class LoggingService {
+    /**
+     * The Cloud Logging client configured with the GCP project ID.
+     */
+    readonly logging: Logging;
+    /**
+     * The GCP project ID.
+     */
+    readonly projectId: string;
+    constructor(context: WorkspaceContext);
+}

package/dist/services/logging.js

@@ -0,0 +1,20 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { Logging } from '@google-cloud/logging';
+/**
+ * A service that provides access to Cloud Logging.
+ */
+export class LoggingService {
+    /**
+     * The Cloud Logging client configured with the GCP project ID.
+     */
+    logging;
+    /**
+     * The GCP project ID.
+     */
+    projectId;
+    constructor(context) {
+        const googleConf = context.asConfiguration();
+        this.projectId = googleConf.getOrThrow('google.project');
+        this.logging = new Logging({ projectId: this.projectId });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.16.0",
+  "version": "0.18.0-beta.1",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",
@@ -35,23 +35,24 @@
     "generateConfigurationSchemas": "cs model genCode && perl -pi -e 's|\\@causa/runtime|\\@causa/workspace/validation|g' src/configurations/generated.ts"
   },
   "dependencies": {
-    "@causa/cli": ">= 0.7.0 < 1.0.0",
-    "@causa/workspace": ">= 0.24.0 < 1.0.0",
-    "@causa/workspace-core": ">= 0.32.0 < 1.0.0",
-    "@causa/workspace-typescript": ">= 0.22.0 < 1.0.0",
-    "@google-cloud/apikeys": "^2.2.1",
-    "@google-cloud/bigquery": "^8.1.1",
-    "@google-cloud/iam-credentials": "^4.2.1",
+    "@causa/cli": ">= 0.8.0-beta.1 < 1.0.0",
+    "@causa/workspace": ">= 0.25.0-beta.3 < 1.0.0",
+    "@causa/workspace-core": ">= 0.35.0-beta.1 < 1.0.0",
+    "@causa/workspace-typescript": ">= 0.23.0-beta.1 < 1.0.0",
+    "@google-cloud/apikeys": "^2.2.2",
+    "@google-cloud/bigquery": "^8.3.1",
+    "@google-cloud/iam-credentials": "^4.2.2",
+    "@google-cloud/logging": "^11.2.1",
     "@google-cloud/pubsub": "^5.3.0",
-    "@google-cloud/resource-manager": "^6.2.1",
-    "@google-cloud/run": "^3.2.0",
-    "@google-cloud/secret-manager": "^6.1.1",
-    "@google-cloud/service-usage": "^4.2.1",
-    "@google-cloud/spanner": "^8.6.0",
+    "@google-cloud/resource-manager": "^6.2.2",
+    "@google-cloud/run": "^3.2.1",
+    "@google-cloud/secret-manager": "^6.1.2",
+    "@google-cloud/service-usage": "^4.2.2",
+    "@google-cloud/spanner": "^8.7.1",
     "@google-cloud/storage": "^7.19.0",
     "class-validator": "^0.15.1",
-    "firebase": "^12.12.1",
-    "firebase-admin": "^13.8.0",
+    "firebase": "^12.13.0",
+    "firebase-admin": "^13.10.0",
     "globby": "^16.2.0",
     "google-auth-library": "^10.6.2",
     "google-gax": "5.0.6",
@@ -61,20 +62,21 @@
     "quicktype-core": "^23.2.6"
   },
   "devDependencies": {
-    "@swc/core": "^1.15.30",
+    "@swc/core": "^1.15.33",
     "@swc/jest": "^0.2.39",
     "@tsconfig/node22": "^22.0.5",
     "@types/jest": "^30.0.0",
     "@types/micromatch": "^4.0.10",
-    "@types/node": "^20.19.39",
+    "@types/node": "^20.19.41",
     "copyfiles": "^2.4.1",
-    "eslint": "^10.2.1",
+    "eslint": "^10.4.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.5",
-    "jest": "^30.3.0",
+    "jest": "^30.4.2",
     "jest-extended": "^7.0.0",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.0"
+    "typescript-eslint": "^8.59.3",
+    "yaml": "^2.9.0"
   }
 }