@causa/workspace-google 1.3.1 → 1.4.0-beta.2

package/dist/graph/terraform-modules.d.ts

@@ -0,0 +1,87 @@
+import type { WorkspaceContext } from '@causa/workspace';
+import { type GraphContext, type GraphResource, type GraphTemplatePart, type GraphWarning, type WorkspaceProject } from '@causa/workspace-core/graph';
+import { type TerraformArgument, type TerraformBlock, type TerraformModuleBlock } from '@causa/workspace-terraform';
+/**
+ * Finds the project whose configuration file a block reads. The argument is a path ending with `<project name>.json`,
+ * the file written by `ProjectWriteConfigurations`.
+ *
+ * @param argument The argument of the module block referencing the configuration file.
+ * @param projects The projects of the workspace.
+ * @returns The project, or `undefined` if the argument does not name a project of the workspace.
+ */
+export declare function projectOfConfigurationFile(argument: TerraformArgument | undefined, projects: readonly WorkspaceProject[]): WorkspaceProject | undefined;
+/**
+ * A block of a workspace-level module, which reads the configuration of an infrastructure project
+ * (`infrastructure_configuration_file`).
+ */
+export type InfrastructureModule = {
+    /**
+     * The module block.
+     */
+    readonly block: TerraformModuleBlock;
+    /**
+     * The infrastructure project whose configuration the module reads.
+     */
+    readonly project: WorkspaceProject | undefined;
+    /**
+     * The context whose configuration the module reads: the project's if it is found, otherwise the workspace's.
+     */
+    readonly context: WorkspaceContext;
+};
+/**
+ * Returns the blocks of a workspace-level module, along with the context whose configuration each reads. The workspace
+ * context is used when the infrastructure project cannot be found.
+ *
+ * @param graph The context of the extraction.
+ * @param source The source of the module, e.g. `causa-io/event-topics-pubsub/google`.
+ * @returns The blocks of the module.
+ */
+export declare function infrastructureModules(graph: GraphContext, source: string): Promise<InfrastructureModule[]>;
+/**
+ * Returns a string argument of a module block, or a reference to the configuration the module falls back to, mirroring
+ * the `coalesce(var.<argument>, <configuration>)` logic of the Causa Terraform modules. When the block passes the
+ * argument but it cannot be evaluated as a string, the configuration is assumed, and a warning is raised.
+ *
+ * @param block The module block.
+ * @param argument The name of the module variable.
+ * @param configuration The path to the configuration value the module falls back to.
+ * @param warnings The warnings to which the one about a computed argument is added.
+ * @returns The literal value of the argument, or a reference to the configuration.
+ */
+export declare function argumentOrConfiguration(block: TerraformModuleBlock, argument: string, configuration: string, warnings: GraphWarning[]): GraphTemplatePart;
+/**
+ * The infrastructure resource created by a Terraform block, before its identifier is built.
+ */
+export type BlockResource = {
+    /**
+     * The type of the resource, e.g. `pubsub.googleapis.com/Topic`.
+     */
+    readonly type: string;
+    /**
+     * The project whose configuration the block reads, if any. Otherwise, the workspace configuration is used.
+     */
+    readonly scope?: WorkspaceProject;
+    /**
+     * The parts of the identifier of the resource.
+     */
+    readonly id: GraphTemplatePart[];
+    /**
+     * Whether {@link BlockResource.id} is only a prefix of the identifier, when the full identifier cannot be known from
+     * the workspace.
+     */
+    readonly prefix?: boolean;
+};
+/**
+ * Returns the infrastructure resource a Terraform block creates.
+ * A block applied by the environment project creates the resource once per environment: its identifier references
+ * the configuration, to be rendered for a given environment, using the configuration of the scope. Other
+ * infrastructure projects do not depend on the environment: the identifier is rendered, and the resource has no
+ * scope. If it cannot be rendered, a warning is raised and the identifier references the configuration.
+ *
+ * @param graph The context of the extraction.
+ * @param block The block creating the resource.
+ * @param resource The resource.
+ * @param warnings The warnings to which the one about an identifier that cannot be rendered is added.
+ * @returns The {@link GraphResource}.
+ */
+export declare function blockResource(graph: GraphContext, block: TerraformBlock, resource: BlockResource, warnings: GraphWarning[]): Promise<GraphResource>;

package/dist/graph/terraform-modules.js

@@ -0,0 +1,107 @@
+import { graphTemplate, projectId, ProjectsFact, renderGraphTemplate, } from '@causa/workspace-core/graph';
+import { modulesWithSource, TerraformProjectsFact, } from '@causa/workspace-terraform';
+import { basename } from 'path';
+/**
+ * Finds the project whose configuration file a block reads. The argument is a path ending with `<project name>.json`,
+ * the file written by `ProjectWriteConfigurations`.
+ *
+ * @param argument The argument of the module block referencing the configuration file.
+ * @param projects The projects of the workspace.
+ * @returns The project, or `undefined` if the argument does not name a project of the workspace.
+ */
+export function projectOfConfigurationFile(argument, projects) {
+    if (argument === undefined) {
+        return undefined;
+    }
+    const path = 'value' in argument ? argument.value : argument.expression;
+    if (typeof path !== 'string') {
+        return undefined;
+    }
+    const file = basename(path);
+    if (!/^[^${}]+\.json$/.test(file)) {
+        return undefined;
+    }
+    const name = file.slice(0, -'.json'.length);
+    return projects.find((p) => p.name === name);
+}
+/**
+ * Returns the blocks of a workspace-level module, along with the context whose configuration each reads. The workspace
+ * context is used when the infrastructure project cannot be found.
+ *
+ * @param graph The context of the extraction.
+ * @param source The source of the module, e.g. `causa-io/event-topics-pubsub/google`.
+ * @returns The blocks of the module.
+ */
+export async function infrastructureModules(graph, source) {
+    const [terraformProjects, projects] = await Promise.all([
+        graph.get(TerraformProjectsFact),
+        graph.get(ProjectsFact),
+    ]);
+    return modulesWithSource(terraformProjects, source).map((block) => {
+        const project = projectOfConfigurationFile(block.arguments['infrastructure_configuration_file'], projects);
+        return { block, project, context: project?.context ?? graph.context };
+    });
+}
+/**
+ * Returns a string argument of a module block, or a reference to the configuration the module falls back to, mirroring
+ * the `coalesce(var.<argument>, <configuration>)` logic of the Causa Terraform modules. When the block passes the
+ * argument but it cannot be evaluated as a string, the configuration is assumed, and a warning is raised.
+ *
+ * @param block The module block.
+ * @param argument The name of the module variable.
+ * @param configuration The path to the configuration value the module falls back to.
+ * @param warnings The warnings to which the one about a computed argument is added.
+ * @returns The literal value of the argument, or a reference to the configuration.
+ */
+export function argumentOrConfiguration(block, argument, configuration, warnings) {
+    const value = block.arguments[argument];
+    if (value === undefined ||
+        ('value' in value && (value.value === null || value.value === ''))) {
+        return { configuration };
+    }
+    if ('value' in value && typeof value.value === 'string') {
+        return value.value;
+    }
+    const expression = 'expression' in value ? value.expression : JSON.stringify(value.value);
+    warnings.push({
+        message: `The argument '${argument}' is computed (${expression}). Assuming the '${configuration}' configuration.`,
+        sources: [block.declaration],
+    });
+    return { configuration };
+}
+/**
+ * Returns the infrastructure resource a Terraform block creates.
+ * A block applied by the environment project creates the resource once per environment: its identifier references
+ * the configuration, to be rendered for a given environment, using the configuration of the scope. Other
+ * infrastructure projects do not depend on the environment: the identifier is rendered, and the resource has no
+ * scope. If it cannot be rendered, a warning is raised and the identifier references the configuration.
+ *
+ * @param graph The context of the extraction.
+ * @param block The block creating the resource.
+ * @param resource The resource.
+ * @param warnings The warnings to which the one about an identifier that cannot be rendered is added.
+ * @returns The {@link GraphResource}.
+ */
+export async function blockResource(graph, block, resource, warnings) {
+    const { type, scope, id, prefix } = resource;
+    const build = (id, scope) => ({
+        type,
+        ...(prefix ? { idPrefix: id } : { id }),
+        ...(scope ? { scope } : {}),
+    });
+    const templated = build(graphTemplate(...id), scope && projectId(scope.directory));
+    if (block.module.project.environment) {
+        return templated;
+    }
+    try {
+        const context = scope?.context ?? graph.context;
+        return build(await renderGraphTemplate(context, ...id));
+    }
+    catch (error) {
+        warnings.push({
+            message: `The identifier of the '${type}' resource cannot be rendered, although the block is not applied by the environment project: ${error.message}`,
+            sources: [block.declaration],
+        });
+        return templated;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "1.3.1",
+  "version": "1.4.0-beta.2",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",
@@ -35,48 +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.0.2",
-    "@causa/workspace-core": "^1.3.0",
-    "@causa/workspace-typescript": "^1.3.0",
-    "@google-cloud/apikeys": "^2.2.2",
-    "@google-cloud/bigquery": "^8.3.1",
-    "@google-cloud/iam-credentials": "^4.2.2",
-    "@google-cloud/logging": "^11.3.0",
-    "@google-cloud/monitoring": "^5.4.0",
-    "@google-cloud/pubsub": "^5.3.1",
-    "@google-cloud/resource-manager": "^6.3.0",
-    "@google-cloud/run": "^3.3.0",
-    "@google-cloud/secret-manager": "^6.3.0",
-    "@google-cloud/service-usage": "^4.2.2",
-    "@google-cloud/spanner": "^8.10.0",
-    "@google-cloud/storage": "^7.21.0",
+    "@causa/cli": "^1.0.1-beta.1",
+    "@causa/workspace": "^1.3.0-beta.1",
+    "@causa/workspace-core": "^1.5.0-beta.2",
+    "@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.1.0",
+    "@google-cloud/iam-credentials": "^5.0.1",
+    "@google-cloud/logging": "^12.1.0",
+    "@google-cloud/monitoring": "^6.1.1",
+    "@google-cloud/pubsub": "^6.1.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",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.1",
-    "firebase": "^12.17.0",
-    "firebase-admin": "^14.2.0",
-    "globby": "^16.2.2",
+    "firebase": "^12.19.0",
+    "firebase-admin": "^14.5.0",
+    "globby": "^16.2.4",
     "google-gax": "5.0.6",
-    "googleapis": "^173.0.0",
+    "googleapis": "^183.0.0",
     "micromatch": "^4.0.8",
-    "pino": "^10.3.1"
+    "pino": "^10.4.0"
   },
   "devDependencies": {
-    "@swc/core": "^1.15.47",
+    "@swc/core": "^1.16.13",
     "@swc/jest": "^0.2.39",
-    "@tsconfig/node22": "^22.0.5",
+    "@tsconfig/node22": "^22.0.6",
     "@types/jest": "^30.0.0",
     "@types/micromatch": "^4.0.10",
-    "@types/node": "^22.20.1",
+    "@types/node": "^22.20.5",
     "copyfiles": "^2.4.1",
-    "eslint": "^10.8.0",
+    "eslint": "^10.12.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.6",
-    "jest": "^30.4.2",
+    "jest": "^30.5.2",
     "jest-extended": "^7.0.0",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.65.0",
-    "yaml": "^2.9.0"
+    "typescript-eslint": "^8.71.1",
+    "yaml": "^2.9.1"
   }
 }