@causa/workspace-google 1.4.0-beta.1 → 1.4.0-beta.3

package/dist/graph/environment/resources.d.ts

@@ -0,0 +1,45 @@
+import type { GraphEnvironmentContext, GraphNodeEntry } from '@causa/workspace-core/graph';
+/**
+ * The segments of a Google Cloud resource name, keyed by collection.
+ * For example, `projects/my-project/locations/europe-west1/services/my-service` is
+ * `{ projects: 'my-project', locations: 'europe-west1', services: 'my-service' }`.
+ */
+export type ResourceNameSegments = Record<string, string>;
+/**
+ * Parses a Google Cloud resource name into its segments.
+ * The `global` segment, which is not followed by an ID (e.g. in `projects/my-project/global/urlMaps/api`), is skipped.
+ *
+ * @param name The resource name.
+ * @returns The segments, keyed by collection.
+ */
+export declare function parseResourceName(name: string): ResourceNameSegments;
+/**
+ * A node whose resource is a Google Cloud resource, along with its full name.
+ */
+export type GoogleResource = {
+    /**
+     * The node.
+     */
+    readonly node: GraphNodeEntry;
+    /**
+     * The type of the resource, e.g. `run.googleapis.com/Service`.
+     */
+    readonly type: string;
+    /**
+     * The full resource name.
+     */
+    readonly name: string;
+    /**
+     * The segments of the resource name.
+     */
+    readonly segments: ResourceNameSegments;
+};
+/**
+ * Returns the Google Cloud resources of the graph, with the segments of their names.
+ *
+ * @param environment The context of the environment.
+ * @param resourceType The type of the resources. Defaults to all Google Cloud resource types.
+ * @param nodeType The type of the nodes. Defaults to all node types.
+ * @returns The resources, in the order of the graph.
+ */
+export declare function googleResources(environment: GraphEnvironmentContext, resourceType?: string, nodeType?: string): GoogleResource[];

package/dist/graph/environment/resources.js

@@ -0,0 +1,49 @@
+/**
+ * Parses a Google Cloud resource name into its segments.
+ * The `global` segment, which is not followed by an ID (e.g. in `projects/my-project/global/urlMaps/api`), is skipped.
+ *
+ * @param name The resource name.
+ * @returns The segments, keyed by collection.
+ */
+export function parseResourceName(name) {
+    const tokens = name.split('/');
+    const segments = {};
+    for (let index = 0; index < tokens.length;) {
+        const collection = tokens[index];
+        if (collection === 'global') {
+            index += 1;
+            continue;
+        }
+        segments[collection] = tokens[index + 1] ?? '';
+        index += 2;
+    }
+    return segments;
+}
+/**
+ * Returns whether a resource type is the type of a Google Cloud resource.
+ *
+ * @param type The type of the resource.
+ * @returns `true` for Google Cloud resource types, e.g. `run.googleapis.com/Service`.
+ */
+function isGoogleResourceType(type) {
+    return type.includes('.googleapis.com/');
+}
+/**
+ * Returns the Google Cloud resources of the graph, with the segments of their names.
+ *
+ * @param environment The context of the environment.
+ * @param resourceType The type of the resources. Defaults to all Google Cloud resource types.
+ * @param nodeType The type of the nodes. Defaults to all node types.
+ * @returns The resources, in the order of the graph.
+ */
+export function googleResources(environment, resourceType, nodeType) {
+    return environment
+        .resources(resourceType, nodeType)
+        .filter(({ resource }) => isGoogleResourceType(resource.type))
+        .map(({ node, resource: { type, id } }) => ({
+        node,
+        type,
+        name: id,
+        segments: parseResourceName(id),
+    }));
+}

package/dist/graph/index.d.ts

@@ -1,4 +1,5 @@
 export * from './cloud-run.js';
+export * from './environment/index.js';
 export * from './ids.js';
 export * from './rules/configuration/index.js';
 export * from './rules/terraform/index.js';

package/dist/graph/index.js

@@ -1,4 +1,5 @@
 export * from './cloud-run.js';
+export * from './environment/index.js';
 export * from './ids.js';
 export * from './rules/configuration/index.js';
 export * from './rules/terraform/index.js';

package/dist/graph/rules/configuration/service-container.js

@@ -1,7 +1,7 @@
 import { GraphOriginKind, } from '@causa/workspace-core';
 import { DomainsFact, ModelFact, projectId, ProjectsFact, topicId, triggerId, } from '@causa/workspace-core/graph';
 import { FIRESTORE_ENGINE, firestoreCollectionPath, SPANNER_ENGINE, } from '../../ids.js';
-import { ddlSource, resolveSpannerTable, SpannerFact } from '../../spanner.js';
+import { ddlSource, resolveEntitySpannerTable, SpannerFact, } from '../../spanner.js';
 /**
  * The elements declared by the Google-specific parts of the `serviceContainer` configuration of every service container
  * project.
@@ -18,7 +18,7 @@ export const googleServiceContainerFromConfiguration = {
     kind: GraphOriginKind.Declared,
     description: 'One `delivers` edge from a topic to each trigger of type `google.pubSub` naming it, when an event schema defines the topic. One `accesses` edge from a project to each entity persisted in a Spanner database or a Firestore collection listed in its `serviceContainer.outputs`.',
     async run(graph) {
-        const { locator } = graph;
+        const { locator, context } = graph;
         const [domains, projects, model, spanner] = await Promise.all([
             graph.get(DomainsFact),
             graph.get(ProjectsFact),
@@ -29,7 +29,7 @@ export const googleServiceContainerFromConfiguration = {
         const warnings = [];
         const entities = [...model.entities.values()];
         const spannerEntities = entities.flatMap((entity) => {
-            const resolution = resolveSpannerTable(spanner, entity, domains);
+            const resolution = resolveEntitySpannerTable(spanner, entity, domains);
             return resolution?.kind === 'resolved' ? [{ entity, resolution }] : [];
         });
         for (const project of projects.filter((p) => p.type === 'serviceContainer')) {
@@ -78,7 +78,7 @@ export const googleServiceContainerFromConfiguration = {
                         type: 'accesses',
                         from: projectId(project.directory),
                         to: entity.id,
-                        sources: [source, ddlSource(resolution.table)],
+                        sources: [source, ddlSource(context.rootPath, resolution.table)],
                     });
                 }
             }

package/dist/graph/rules/terraform/spanner-databases.js

@@ -2,7 +2,7 @@ import { GraphOriginKind, } from '@causa/workspace-core';
 import { databaseId, tableId, tableLocator, DomainsFact, ModelFact, nodeId, } from '@causa/workspace-core/graph';
 import { terraformDeploys } from '@causa/workspace-terraform';
 import { SPANNER_ENGINE, spannerInstanceId } from '../../ids.js';
-import { ddlSource, resolveSpannerTable, SpannerFact } from '../../spanner.js';
+import { ddlSource, resolveEntitySpannerTable, SpannerFact, } from '../../spanner.js';
 import { blockResource, infrastructureModules, argumentOrConfiguration, } from '../../terraform-modules.js';
 /**
  * The source of the Causa Terraform module creating the Spanner instance and databases.
@@ -135,13 +135,13 @@ export const spannerDatabasesModule = {
                     locator: nodeLocator,
                     parent: databaseId(database.locator),
                     name: table.name,
-                    sources: [ddlSource(table), ...blocks],
+                    sources: [ddlSource(context.rootPath, table), ...blocks],
                 });
                 edges.push(...spannerDatabases.flatMap((module) => terraformDeploys(module.block, nodeId('table', nodeLocator))));
             }
         }
         for (const entity of model.entities.values()) {
-            const resolution = resolveSpannerTable(spanner, entity, domains);
+            const resolution = resolveEntitySpannerTable(spanner, entity, domains);
             if (!resolution) {
                 continue;
             }
@@ -172,7 +172,7 @@ export const spannerDatabasesModule = {
                 type: 'realizes',
                 from: tableId(resolution.database.locator, resolution.table.name),
                 to: entity.id,
-                sources: [binding, ddlSource(resolution.table)],
+                sources: [binding, ddlSource(context.rootPath, resolution.table)],
             });
         }
         return { nodes, edges, warnings };

package/dist/graph/spanner.d.ts

@@ -1,30 +1,10 @@
 import type { GraphOriginSource } from '@causa/workspace-core';
-import { GraphFact, type EntityFacts, type GraphContext, type GraphFactOutput, type WorkspaceDomain } from '@causa/workspace-core/graph';
+import { GraphExtractionFact, type EntityFacts, type GraphContext, type GraphFactOutput, type WorkspaceDomain } from '@causa/workspace-core/graph';
+import { type SpannerDatabase, type SpannerTable, type SpannerTableResolution } from '../functions/google-spanner/index.js';
 /**
- * A table created by a `CREATE TABLE` statement in a Spanner DDL file.
+ * A Spanner database of the workspace, as `GoogleSpannerListDatabases` lists it, and its graph identifiers.
  */
-export type SpannerTable = {
-    /**
-     * The name of the table.
-     */
-    readonly name: string;
-    /**
-     * The DDL file declaring the table, relative to the workspace root.
-     */
-    readonly file: string;
-    /**
-     * The line of the statement in the file.
-     */
-    readonly line: number;
-};
-/**
- * A Spanner database of the workspace, and the tables its DDL files create.
- */
-export type SpannerDatabaseFacts = {
-    /**
-     * The ID of the database, as `GoogleSpannerListDatabases` returns it.
-     */
-    readonly id: string;
+export type SpannerDatabaseFacts = SpannerDatabase & {
     /**
      * The name of the database within its engine, `<instance>.<database>`, as `outputs['google.spanner']` lists it.
      */
@@ -37,14 +17,6 @@ export type SpannerDatabaseFacts = {
      * The directory holding the DDL files, relative to the workspace root.
      */
     readonly directory: string;
-    /**
-     * The domain the DDL files belong to.
-     */
-    readonly domain: WorkspaceDomain | undefined;
-    /**
-     * The tables created by the DDL files.
-     */
-    readonly tables: SpannerTable[];
 };
 /**
  * The Spanner databases of the workspace.
@@ -60,47 +32,26 @@ export type SpannerFacts = {
     readonly databases: SpannerDatabaseFacts[];
 };
 /**
- * The Spanner databases of the workspace, as `GoogleSpannerListDatabases` lists them, and the tables their DDL files
- * create.
+ * The Spanner databases of the workspace, as `GoogleSpannerListDatabases` lists them.
  */
-export declare class SpannerFact extends GraphFact<SpannerFacts> {
+export declare class SpannerFact extends GraphExtractionFact<SpannerFacts> {
     compute(graph: GraphContext): Promise<GraphFactOutput<SpannerFacts>>;
-    /**
-     * Parses the tables created by the `CREATE TABLE` statements of DDL files.
-     *
-     * @param context The workspace context.
-     * @param files The DDL files, relative to the workspace root.
-     * @returns The tables, in the order of the files and statements.
-     */
-    private parseTables;
 }
 /**
- * The resolution of an entity's Spanner binding to a table.
- */
-export type SpannerTableResolution = {
-    readonly kind: 'resolved';
-    readonly database: SpannerDatabaseFacts;
-    readonly table: SpannerTable;
-} | {
-    readonly kind: 'ambiguous';
-    readonly candidates: SpannerDatabaseFacts[];
-} | {
-    readonly kind: 'missing';
-};
-/**
- * Resolves the Spanner binding of an entity to the database whose DDL creates a table of that name. When several
- * databases declare the name, the one in the entity's domain is chosen.
+ * Resolves the Spanner binding of an entity to the database whose DDL creates a table of that name, using
+ * {@link resolveSpannerTable}.
  *
  * @param spanner The Spanner databases.
  * @param entity The entity.
  * @param domains The domains of the workspace, in which the domain of the entity is looked up.
  * @returns The resolution, or `undefined` if the entity is not persisted in Spanner.
  */
-export declare function resolveSpannerTable(spanner: SpannerFacts, entity: EntityFacts, domains: readonly WorkspaceDomain[]): SpannerTableResolution | undefined;
+export declare function resolveEntitySpannerTable(spanner: SpannerFacts, entity: EntityFacts, domains: readonly WorkspaceDomain[]): SpannerTableResolution<SpannerDatabaseFacts> | undefined;
 /**
  * Returns the origin source of a `CREATE TABLE` statement.
  *
+ * @param rootPath The absolute path of the workspace root.
  * @param table The table.
  * @returns The origin source.
  */
-export declare function ddlSource(table: SpannerTable): GraphOriginSource;
+export declare function ddlSource(rootPath: string, table: SpannerTable): GraphOriginSource;

package/dist/graph/spanner.js

@@ -1,35 +1,27 @@
-import { domainAt, domainOfFile, DomainsFact, GraphFact, } from '@causa/workspace-core/graph';
-import { readFile } from 'fs/promises';
-import { dirname, join, relative } from 'path';
-import { GoogleSpannerListDatabases } from '../functions/google-spanner/index.js';
+import { GraphExtractionFact, } from '@causa/workspace-core/graph';
+import { splitSchemaPath } from '@causa/workspace-core/jsonschema';
+import { dirname, relative } from 'path';
+import { GoogleSpannerListDatabases, resolveSpannerTable, } from '../functions/google-spanner/index.js';
 import { SPANNER_ENGINE, spannerDatabaseLocator, spannerDatabaseName, } from './ids.js';
 /**
- * The Spanner databases of the workspace, as `GoogleSpannerListDatabases` lists them, and the tables their DDL files
- * create.
+ * The Spanner databases of the workspace, as `GoogleSpannerListDatabases` lists them.
  */
-export class SpannerFact extends GraphFact {
+export class SpannerFact extends GraphExtractionFact {
     async compute(graph) {
         const { context } = graph;
         const instance = context
             .asConfiguration()
             .get('google.spanner.instance.name');
-        const [listed, domains] = await Promise.all([
-            context.call(GoogleSpannerListDatabases, {}),
-            graph.get(DomainsFact),
-        ]);
-        const databases = await Promise.all(listed.map(async ({ id, ddlFiles }) => {
-            const files = ddlFiles.map((f) => relative(context.rootPath, f)).sort();
-            const tables = await this.parseTables(context, files);
-            const directory = files[0] ? dirname(files[0]) : '';
+        const listed = await context.call(GoogleSpannerListDatabases, {});
+        const databases = listed.map((database) => {
+            const [file] = database.ddlFiles;
             return {
-                id,
-                name: spannerDatabaseName(instance ?? '', id),
-                locator: spannerDatabaseLocator(instance ?? '', id),
-                directory,
-                domain: directory ? domainAt(domains, directory) : undefined,
-                tables,
+                ...database,
+                name: spannerDatabaseName(instance ?? '', database.id),
+                locator: spannerDatabaseLocator(instance ?? '', database.id),
+                directory: file ? dirname(relative(context.rootPath, file)) : '',
             };
-        }));
+        });
         databases.sort((a, b) => a.id.localeCompare(b.id));
         const warnings = [];
         for (const database of databases) {
@@ -38,7 +30,7 @@ export class SpannerFact extends GraphFact {
                 if (names.has(table.name)) {
                     warnings.push({
                         message: `Table '${table.name}' is created twice in database '${database.id}'.`,
-                        sources: [ddlSource(table)],
+                        sources: [ddlSource(context.rootPath, table)],
                     });
                 }
                 names.add(table.name);
@@ -46,72 +38,36 @@ export class SpannerFact extends GraphFact {
         }
         return { value: { instance, databases }, warnings };
     }
-    /**
-     * Parses the tables created by the `CREATE TABLE` statements of DDL files.
-     *
-     * @param context The workspace context.
-     * @param files The DDL files, relative to the workspace root.
-     * @returns The tables, in the order of the files and statements.
-     */
-    async parseTables(context, files) {
-        const tables = [];
-        for (const file of files) {
-            const content = await readFile(join(context.rootPath, file), 'utf-8');
-            const withoutComments = content.replace(/--.*$/gm, (m) => ' '.repeat(m.length));
-            const statements = withoutComments.matchAll(/\bCREATE\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"']?([A-Za-z_]\w*)[`"']?/gi);
-            for (const match of statements) {
-                tables.push({
-                    name: match[1],
-                    file,
-                    line: withoutComments.slice(0, match.index).split('\n').length,
-                });
-            }
-        }
-        return tables;
-    }
 }
 /**
- * Resolves the Spanner binding of an entity to the database whose DDL creates a table of that name. When several
- * databases declare the name, the one in the entity's domain is chosen.
+ * Resolves the Spanner binding of an entity to the database whose DDL creates a table of that name, using
+ * {@link resolveSpannerTable}.
  *
  * @param spanner The Spanner databases.
  * @param entity The entity.
  * @param domains The domains of the workspace, in which the domain of the entity is looked up.
  * @returns The resolution, or `undefined` if the entity is not persisted in Spanner.
  */
-export function resolveSpannerTable(spanner, entity, domains) {
-    const { definition, file } = entity.schema;
+export function resolveEntitySpannerTable(spanner, entity, domains) {
+    const { definition, path } = entity.schema;
     const table = definition.databases.find((d) => d.engine === SPANNER_ENGINE)?.table;
     if (!table) {
         return undefined;
     }
-    const candidates = spanner.databases.filter((d) => d.tables.some((t) => t.name === table));
-    const pick = (database) => ({
-        kind: 'resolved',
-        database,
-        table: database.tables.find((t) => t.name === table),
-    });
-    if (candidates.length === 1) {
-        return pick(candidates[0]);
-    }
-    if (candidates.length === 0) {
-        return { kind: 'missing' };
-    }
-    const domain = domainOfFile(domains, file);
-    const sameDomain = candidates.filter((d) => domain && d.domain?.directory === domain.directory);
-    return sameDomain.length === 1
-        ? pick(sameDomain[0])
-        : { kind: 'ambiguous', candidates };
+    return resolveSpannerTable(spanner.databases, table, splitSchemaPath(path).file, 
+    // The working directory of a domain's context is the absolute path of the domain.
+    domains.map((d) => d.context.workingDirectory));
 }
 /**
  * Returns the origin source of a `CREATE TABLE` statement.
  *
+ * @param rootPath The absolute path of the workspace root.
  * @param table The table.
  * @returns The origin source.
  */
-export function ddlSource(table) {
+export function ddlSource(rootPath, table) {
     return {
-        path: table.file,
+        path: relative(rootPath, table.file),
         pointer: `CREATE TABLE ${table.name}`,
         location: { start: { line: table.line } },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "1.4.0-beta.1",
+  "version": "1.4.0-beta.3",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",
@@ -35,49 +35,49 @@
     "generateConfigurationSchemas": "cs model genCode && perl -pi -e 's|\\@causa/runtime|\\@causa/workspace/validation|g' src/configurations/generated.ts"
   },
   "dependencies": {
-    "@causa/cli": "^1.0.0",
-    "@causa/workspace": "^1.2.0",
-    "@causa/workspace-core": "^1.5.0-beta.1",
-    "@causa/workspace-terraform": "^1.1.0-beta.1",
-    "@causa/workspace-typescript": "^1.3.0",
-    "@google-cloud/apikeys": "^3.1.0",
-    "@google-cloud/bigquery": "^9.1.0",
-    "@google-cloud/iam-credentials": "^5.0.0",
-    "@google-cloud/logging": "^12.1.0",
-    "@google-cloud/monitoring": "^6.1.0",
-    "@google-cloud/pubsub": "^6.1.0",
-    "@google-cloud/resource-manager": "^7.1.0",
-    "@google-cloud/run": "^4.1.0",
-    "@google-cloud/secret-manager": "^7.1.0",
-    "@google-cloud/service-usage": "^5.1.0",
+    "@causa/cli": "^1.0.1-beta.1",
+    "@causa/workspace": "^1.3.0-beta.1",
+    "@causa/workspace-core": "^1.5.0-beta.3",
+    "@causa/workspace-terraform": "^1.1.0-beta.2",
+    "@causa/workspace-typescript": "^1.4.0-beta.1",
+    "@google-cloud/apikeys": "^3.1.1",
+    "@google-cloud/bigquery": "^9.2.0",
+    "@google-cloud/iam-credentials": "^5.0.1",
+    "@google-cloud/logging": "^12.2.0",
+    "@google-cloud/monitoring": "^6.1.1",
+    "@google-cloud/pubsub": "^6.2.0",
+    "@google-cloud/resource-manager": "^7.1.1",
+    "@google-cloud/run": "^4.1.1",
+    "@google-cloud/secret-manager": "^7.1.1",
+    "@google-cloud/service-usage": "^5.1.1",
     "@google-cloud/spanner": "^9.0.0",
-    "@google-cloud/storage": "^8.2.0",
+    "@google-cloud/storage": "^8.4.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.1",
-    "firebase": "^12.19.0",
+    "firebase": "^13.0.0",
     "firebase-admin": "^14.5.0",
     "globby": "^16.2.4",
     "google-gax": "5.0.6",
-    "googleapis": "^182.0.0",
+    "googleapis": "^185.0.0",
     "micromatch": "^4.0.8",
-    "pino": "^10.3.1"
+    "pino": "^10.4.0"
   },
   "devDependencies": {
-    "@swc/core": "^1.16.2",
+    "@swc/core": "^1.16.13",
     "@swc/jest": "^0.2.39",
     "@tsconfig/node22": "^22.0.6",
     "@types/jest": "^30.0.0",
     "@types/micromatch": "^4.0.10",
-    "@types/node": "^22.20.4",
+    "@types/node": "^22.20.5",
     "copyfiles": "^2.4.1",
-    "eslint": "^10.11.0",
+    "eslint": "^10.12.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.6",
     "jest": "^30.5.2",
     "jest-extended": "^7.0.0",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.70.1",
+    "typescript-eslint": "^8.71.1",
     "yaml": "^2.9.1"
   }
 }