@open-rlb/nestjs-amqp 2.1.1 → 2.2.0

package/schematics/add-gateway/wiring.ts

@@ -0,0 +1,115 @@
+import { brokerModuleEntry, configModuleEntry, WireEntry } from '../utils/nest-wiring.util';
+
+/**
+ * The AppModule wiring for a gateway: the lib symbols to import, the helper import lines, and the
+ * `@Module` imports[] entries with idempotency sentinels. Mirrors what nest-add generated for the
+ * gateway case, now owned by add-gateway so a promote-to-gateway run wires a working app.
+ * HttpModule / ProxyModule share the `ProxyModule.forRootAsync` sentinel (the gateway pair), so both
+ * are added together when absent and skipped together on a re-run.
+ */
+
+export interface GwFeatures {
+  acl: boolean;
+  admin: boolean;
+  routeReception: boolean;
+  routeExchange: string;
+  routeQueue: string;
+}
+
+export function libSymbols(f: GwFeatures): string[] {
+  const s = ['AppConfig', 'BrokerModule', 'BrokerTopic', 'GatewayConfig', 'HandlerAuthConfig', 'ProxyModule', 'RabbitMQConfig'];
+  if (f.acl) s.push('AclActionRepository', 'AclGrantRepository', 'AclModule', 'AclRoleRepository', 'AclService', 'RLB_ACL_CACHE_STORE', 'RLB_GTW_ACL_ROLE_SERVICE');
+  if (f.admin || f.routeReception) s.push('AuthProviderRepository', 'GatewayAdminModule', 'HttpMetricRepository', 'HttpPathRepository', 'RouteSyncLogRepository');
+  if (f.admin) s.push('RLB_GTW_AUTH_PROVIDER_SOURCE');
+  return s;
+}
+
+export function importLines(f: GwFeatures): { line: string; marker: string }[] {
+  const lines = [
+    { line: `import { ConfigModule, ConfigService } from '@nestjs/config';`, marker: '@nestjs/config' },
+    { line: `import yamlConfig from './config/config.loader';`, marker: './config/config.loader' },
+    { line: `import { HttpModule } from '@nestjs/axios';`, marker: '@nestjs/axios' },
+  ];
+  if (f.acl) {
+    lines.push({ line: `import { InMemoryAclActionRepository, InMemoryAclGrantRepository, InMemoryAclRoleRepository } from './modules/database/repository/acl.repository';`, marker: './modules/database/repository/acl.repository' });
+    lines.push({ line: `import { InMemoryAclStore } from './cache/in-memory-acl-store';`, marker: './cache/in-memory-acl-store' });
+  }
+  if (f.admin || f.routeReception) {
+    lines.push({ line: `import { InMemoryAuthProviderRepository, InMemoryHttpMetricRepository, InMemoryHttpPathRepository } from './modules/database/repository/gateway.repository';`, marker: './modules/database/repository/gateway.repository' });
+    lines.push({ line: `import { InMemoryRouteSyncLogRepository } from './modules/database/repository/route-sync.repository';`, marker: './modules/database/repository/route-sync.repository' });
+  }
+  return lines;
+}
+
+const GATEWAY_SENTINEL = 'ProxyModule.forRootAsync';
+
+export function moduleEntries(f: GwFeatures): WireEntry[] {
+  // ConfigModule + BrokerModule come from the shared core builders (single source of truth with nest-add).
+  const entries: WireEntry[] = [
+    configModuleEntry(),
+    brokerModuleEntry(),
+    { code: `HttpModule`, sentinel: GATEWAY_SENTINEL },
+    { code: proxyForRootAsync(f), sentinel: GATEWAY_SENTINEL },
+  ];
+  if (f.acl) entries.push({ code: aclForRoot(), sentinel: 'AclModule.forRoot' });
+  if (f.admin || f.routeReception) entries.push({ code: gatewayAdminForRoot(f), sentinel: 'GatewayAdminModule.forRoot' });
+  return entries;
+}
+
+function proxyForRootAsync(f: GwFeatures): string {
+  const provs: string[] = [];
+  if (f.acl)
+    provs.push(`        // Action-gated paths resolve the caller's identity via AclService (in-process, no broker hop).
+        { provide: RLB_GTW_ACL_ROLE_SERVICE, useExisting: AclService },`);
+  if (f.admin)
+    provs.push(`        // DB auth-provider source for the runtime registry; activated by a deliberate gw-auth-reload.
+        { provide: RLB_GTW_AUTH_PROVIDER_SOURCE, useExisting: InMemoryAuthProviderRepository },`);
+  const providers = provs.length ? `[\n${provs.join('\n')}\n      ]` : `[]`;
+  return `ProxyModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService: ConfigService) => ({
+        authOptions: configService.get<HandlerAuthConfig[]>('auth-providers'),
+        gatewayOptions: configService.get<GatewayConfig>('gateway'),
+      }),
+      providers: ${providers},
+    })`;
+}
+
+function aclForRoot(): string {
+  return `AclModule.forRoot(
+      [
+        InMemoryAclActionRepository,
+        { provide: AclActionRepository, useExisting: InMemoryAclActionRepository },
+        InMemoryAclRoleRepository,
+        { provide: AclRoleRepository, useExisting: InMemoryAclRoleRepository },
+        InMemoryAclGrantRepository,
+        { provide: AclGrantRepository, useExisting: InMemoryAclGrantRepository },
+        InMemoryAclStore,
+        { provide: RLB_ACL_CACHE_STORE, useExisting: InMemoryAclStore },
+      ],
+      { cache: { ramTtlMs: 30000, l2TtlSec: 600 } },
+    )`;
+}
+
+function gatewayAdminForRoot(f: GwFeatures): string {
+  const options = f.routeReception
+    ? `,
+      {
+        // Consumer-side route-discovery — names MUST match the publishers' broker.routeDiscovery.
+        routeDiscovery: { exchange: '${f.routeExchange}', queue: '${f.routeQueue}' },
+      }`
+    : '';
+  return `GatewayAdminModule.forRoot(
+      [
+        InMemoryHttpPathRepository,
+        { provide: HttpPathRepository, useExisting: InMemoryHttpPathRepository },
+        InMemoryAuthProviderRepository,
+        { provide: AuthProviderRepository, useExisting: InMemoryAuthProviderRepository },
+        InMemoryHttpMetricRepository,
+        { provide: HttpMetricRepository, useExisting: InMemoryHttpMetricRepository },
+        InMemoryRouteSyncLogRepository,
+        { provide: RouteSyncLogRepository, useExisting: InMemoryRouteSyncLogRepository },
+      ]${options},
+    )`;
+}

package/schematics/add-metrics-topic/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { AddMetricsTopicOptions } from './schema';
+export declare function main(options: AddMetricsTopicOptions): Rule;

package/schematics/add-metrics-topic/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const broker_yaml_util_1 = require("../utils/broker-yaml.util");
+const schematic_prompt_util_1 = require("../utils/schematic-prompt.util");
+const yaml_config_util_1 = require("../utils/yaml-config.util");
+function main(options) {
+    return async (tree, context) => {
+        const flagsProvided = options.topic !== undefined;
+        const prompts = (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        const topic = options.topic || (await (0, schematic_prompt_util_1.askText)(prompts, 'Metrics topic name?', 'rlb-gateway-metrics'));
+        const queue = options.queue || (await (0, schematic_prompt_util_1.askText)(prompts, 'Queue backing the topic?', topic));
+        const exchange = options.exchange || (await (0, schematic_prompt_util_1.askText)(prompts, 'Exchange?', 'rlb'));
+        const messageTtl = options.messageTtl ?? (await (0, schematic_prompt_util_1.askNumber)(prompts, 'Queue messageTtl (ms)?', 3600000));
+        const maxLength = options.maxLength ?? (await (0, schematic_prompt_util_1.askNumber)(prompts, 'Queue maxLength?', 500000));
+        const action = options.action || (await (0, schematic_prompt_util_1.askText)(prompts, 'Metrics action?', 'gw-metrics-track'));
+        const configPath = (0, yaml_config_util_1.findConfigYaml)(tree, options.config);
+        const { doc, existed } = (0, yaml_config_util_1.readConfigDoc)(tree, configPath);
+        if (!existed)
+            context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+        const qOutcome = (0, broker_yaml_util_1.ensureQueue)(doc, { name: queue, exchange, routingKey: queue, createQueueIfNotExists: true, durable: true, messageTtl, maxLength }, { overwrite: options.overwrite });
+        (0, schematic_prompt_util_1.logOutcome)(context, `queue '${queue}'`, qOutcome);
+        const tOutcome = (0, broker_yaml_util_1.ensureTopic)(doc, { name: topic, mode: 'handle', queue, exchange, routingKey: queue }, { overwrite: options.overwrite });
+        (0, schematic_prompt_util_1.logOutcome)(context, `topic '${topic}'`, tOutcome);
+        const gOutcome = (0, yaml_config_util_1.setIn)(doc, ['gateway', 'metrics'], { topic, action });
+        (0, schematic_prompt_util_1.logOutcome)(context, 'gateway.metrics', gOutcome);
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/add-metrics-topic/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-metrics-topic/index.ts"],"names":[],"mappings":";;AAYA,oBAoCC;AA/CD,gEAAqE;AACrE,0EAA6F;AAC7F,gEAAiG;AASjG,SAAgB,IAAI,CAAC,OAA+B;IAClD,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;QAClD,MAAM,OAAO,GAAG,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,CAAC,CAAC,CAAC;QACtG,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,0BAA0B,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3F,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QAClF,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,MAAM,IAAA,iCAAS,EAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC,CAAC;QACvG,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,MAAM,IAAA,iCAAS,EAAC,OAAO,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9F,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAEjG,MAAM,UAAU,GAAG,IAAA,iCAAc,EAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,gCAAa,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,UAAU,2BAA2B,CAAC,CAAC;QAEvF,MAAM,QAAQ,GAAG,IAAA,8BAAW,EAC1B,GAAG,EACH,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,EAChH,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACjC,CAAC;QACF,IAAA,kCAAU,EAAC,OAAO,EAAE,UAAU,KAAK,GAAG,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAA,8BAAW,EAC1B,GAAG,EACH,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,EACnE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACjC,CAAC;QACF,IAAA,kCAAU,EAAC,OAAO,EAAE,UAAU,KAAK,GAAG,EAAE,QAAQ,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAA,wBAAK,EAAC,GAAG,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACvE,IAAA,kCAAU,EAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAEjD,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/add-metrics-topic/index.spec.ts

@@ -0,0 +1,79 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { AddMetricsTopicOptions } from './schema';
+
+/**
+ * Factory is invoked directly against a Tree (not SchematicTestRunner, whose testing entrypoint
+ * eagerly loads the ESM-only `ora`). Passing `topic` makes `flagsProvided` true → no prompts.
+ */
+const ctx = { logger: { info() {}, warn() {}, error() {} } } as unknown as SchematicContext;
+
+async function run(options: AddMetricsTopicOptions, tree: Tree): Promise<Tree> {
+  const rule = main(options) as Rule;
+  const result = await (rule as (t: Tree, c: SchematicContext) => Promise<Tree>)(tree, ctx);
+  return result || tree;
+}
+
+function read(tree: Tree, path = 'config/config.yaml'): string {
+  return tree.read(path)!.toString('utf-8');
+}
+function doc(tree: Tree) {
+  return parseDocument(read(tree));
+}
+function seedConfig(): Tree {
+  const tree = Tree.empty();
+  tree.create(
+    'config/config.yaml',
+    ['# my config', 'broker:', '  queues: []', 'topics: []', 'gateway:', '  paths: []', ''].join('\n'),
+  );
+  return tree;
+}
+
+describe('add-metrics-topic schematic', () => {
+  it('creates a bounded queue, a handle topic and points gateway.metrics at it', async () => {
+    const tree = await run({ topic: 'rlb-gateway-metrics' }, seedConfig());
+    const d = doc(tree);
+
+    const queue = (d.getIn(['broker', 'queues']) as any).items[0];
+    expect(String(queue.get('name'))).toBe('rlb-gateway-metrics');
+    expect(String(queue.get('exchange'))).toBe('rlb');
+    expect(String(queue.get('routingKey'))).toBe('rlb-gateway-metrics');
+    const qOpts = queue.get('options');
+    expect(Number(qOpts.get('messageTtl'))).toBe(3600000);
+    expect(Number(qOpts.get('maxLength'))).toBe(500000);
+
+    const topic = (d.getIn(['topics']) as any).items[0];
+    expect(String(topic.get('name'))).toBe('rlb-gateway-metrics');
+    expect(String(topic.get('mode'))).toBe('handle');
+    expect(String(topic.get('queue'))).toBe('rlb-gateway-metrics');
+
+    expect(String(d.getIn(['gateway', 'metrics', 'topic']))).toBe('rlb-gateway-metrics');
+    expect(String(d.getIn(['gateway', 'metrics', 'action']))).toBe('gw-metrics-track');
+    expect(read(tree)).toContain('# my config');
+  });
+
+  it('honours an explicit queue name and custom bounds/action', async () => {
+    const tree = await run(
+      { topic: 'metrics-t', queue: 'metrics-q', exchange: 'ex', messageTtl: 60000, maxLength: 100, action: 'track' },
+      seedConfig(),
+    );
+    const d = doc(tree);
+    const queue = (d.getIn(['broker', 'queues']) as any).items[0];
+    expect(String(queue.get('name'))).toBe('metrics-q');
+    expect(String(queue.get('exchange'))).toBe('ex');
+    expect(Number(queue.get('options').get('messageTtl'))).toBe(60000);
+    expect(String(d.getIn(['topics'] as any) && (d.getIn(['topics']) as any).items[0].get('queue'))).toBe('metrics-q');
+    expect(String(d.getIn(['gateway', 'metrics', 'action']))).toBe('track');
+  });
+
+  it('is idempotent: re-running leaves a single queue/topic entry', async () => {
+    let tree = await run({ topic: 'rlb-gateway-metrics' }, seedConfig());
+    tree = await run({ topic: 'rlb-gateway-metrics' }, tree);
+    const d = doc(tree);
+    const queues = (d.getIn(['broker', 'queues']) as any).items.map((i: any) => String(i.get('name')));
+    const topics = (d.getIn(['topics']) as any).items.map((i: any) => String(i.get('name')));
+    expect(queues.filter((n: string) => n === 'rlb-gateway-metrics')).toHaveLength(1);
+    expect(topics.filter((n: string) => n === 'rlb-gateway-metrics')).toHaveLength(1);
+  });
+});

package/schematics/add-metrics-topic/index.ts

@@ -0,0 +1,49 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { ensureQueue, ensureTopic } from '../utils/broker-yaml.util';
+import { askNumber, askText, loadPrompts, logOutcome } from '../utils/schematic-prompt.util';
+import { findConfigYaml, readConfigDoc, setIn, writeConfigDoc } from '../utils/yaml-config.util';
+import { AddMetricsTopicOptions } from './schema';
+
+/**
+ * `add-metrics-topic` — move the gateway's per-request metrics off the shared rlb-gateway-admin
+ * queue onto a dedicated, growth-bounded topic/queue (messageTtl + maxLength) and repoint
+ * `gateway.metrics` at it. Idempotent + comment-preserving; the queue/topic upserts go through the
+ * broker DATA helpers directly (no prompt ping-pong).
+ */
+export function main(options: AddMetricsTopicOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    const flagsProvided = options.topic !== undefined;
+    const prompts = loadPrompts(context, flagsProvided);
+
+    const topic = options.topic || (await askText(prompts, 'Metrics topic name?', 'rlb-gateway-metrics'));
+    const queue = options.queue || (await askText(prompts, 'Queue backing the topic?', topic));
+    const exchange = options.exchange || (await askText(prompts, 'Exchange?', 'rlb'));
+    const messageTtl = options.messageTtl ?? (await askNumber(prompts, 'Queue messageTtl (ms)?', 3600000));
+    const maxLength = options.maxLength ?? (await askNumber(prompts, 'Queue maxLength?', 500000));
+    const action = options.action || (await askText(prompts, 'Metrics action?', 'gw-metrics-track'));
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    const qOutcome = ensureQueue(
+      doc,
+      { name: queue, exchange, routingKey: queue, createQueueIfNotExists: true, durable: true, messageTtl, maxLength },
+      { overwrite: options.overwrite },
+    );
+    logOutcome(context, `queue '${queue}'`, qOutcome);
+
+    const tOutcome = ensureTopic(
+      doc,
+      { name: topic, mode: 'handle', queue, exchange, routingKey: queue },
+      { overwrite: options.overwrite },
+    );
+    logOutcome(context, `topic '${topic}'`, tOutcome);
+
+    const gOutcome = setIn(doc, ['gateway', 'metrics'], { topic, action });
+    logOutcome(context, 'gateway.metrics', gOutcome);
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/add-metrics-topic/schema.d.ts

@@ -0,0 +1,10 @@
+export interface AddMetricsTopicOptions {
+    topic?: string;
+    queue?: string;
+    exchange?: string;
+    messageTtl?: number;
+    maxLength?: number;
+    action?: string;
+    overwrite?: boolean;
+    config?: string;
+}

package/schematics/add-metrics-topic/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/add-metrics-topic/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-metrics-topic/schema.ts"],"names":[],"mappings":""}

package/schematics/add-metrics-topic/schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsRlbAmqpAddMetricsTopic",
+  "title": "Isolate gateway metrics on a dedicated bounded topic/queue",
+  "type": "object",
+  "properties": {
+    "topic": {
+      "type": "string",
+      "default": "rlb-gateway-metrics",
+      "description": "Metrics topic name.",
+      "$default": { "$source": "argv", "index": 0 }
+    },
+    "queue": {
+      "type": "string",
+      "description": "Queue backing the topic (default: the topic value)."
+    },
+    "exchange": {
+      "type": "string",
+      "default": "rlb",
+      "description": "Exchange the queue binds to."
+    },
+    "messageTtl": {
+      "type": "number",
+      "default": 3600000,
+      "description": "Queue options.messageTtl (ms)."
+    },
+    "maxLength": {
+      "type": "number",
+      "default": 500000,
+      "description": "Queue options.maxLength."
+    },
+    "action": {
+      "type": "string",
+      "default": "gw-metrics-track",
+      "description": "Action the gateway emits metrics with."
+    },
+    "overwrite": {
+      "type": "boolean",
+      "default": false,
+      "description": "Update the entries if they already exist (default: leave them untouched)."
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to config.yaml (default: auto-detected)."
+    }
+  },
+  "required": []
+}

package/schematics/add-metrics-topic/schema.ts

@@ -0,0 +1,18 @@
+export interface AddMetricsTopicOptions {
+  /** Metrics topic name. Default: 'rlb-gateway-metrics'. */
+  topic?: string;
+  /** Queue backing the topic. Default: the topic value. */
+  queue?: string;
+  /** Exchange the queue binds to. Default: 'rlb'. */
+  exchange?: string;
+  /** Queue options.messageTtl (ms). Default: 3600000. */
+  messageTtl?: number;
+  /** Queue options.maxLength. Default: 500000. */
+  maxLength?: number;
+  /** Action the gateway emits metrics with. Default: 'gw-metrics-track'. */
+  action?: string;
+  /** Update the entries when they already exist (default: leave them untouched). */
+  overwrite?: boolean;
+  /** Path to config.yaml (default: auto-detected, typically config/config.yaml). */
+  config?: string;
+}

package/schematics/add-queue/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { AddQueueOptions } from './schema';
+export declare function main(options: AddQueueOptions): Rule;

package/schematics/add-queue/index.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const broker_yaml_util_1 = require("../utils/broker-yaml.util");
+const schematic_prompt_util_1 = require("../utils/schematic-prompt.util");
+const yaml_config_util_1 = require("../utils/yaml-config.util");
+const TYPES = ['direct', 'topic', 'fanout', 'headers'];
+function main(options) {
+    return async (tree, context) => {
+        const flagsProvided = options.name !== undefined;
+        const prompts = (0, schematic_prompt_util_1.loadPrompts)(context, flagsProvided);
+        const name = options.name || (await (0, schematic_prompt_util_1.askText)(prompts, 'Queue name?', ''));
+        if (!name) {
+            context.logger.error('[rlb-amqp] add-queue: a name is required.');
+            return tree;
+        }
+        const exchange = options.exchange || (await (0, schematic_prompt_util_1.askText)(prompts, 'Bind to which exchange?', 'rlb'));
+        const configPath = (0, yaml_config_util_1.findConfigYaml)(tree, options.config);
+        const { doc, existed } = (0, yaml_config_util_1.readConfigDoc)(tree, configPath);
+        if (!existed)
+            context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+        if (!(0, broker_yaml_util_1.exchangeExists)(doc, exchange)) {
+            const createExchange = options.createExchange ?? (await (0, schematic_prompt_util_1.askConfirm)(prompts, `Exchange '${exchange}' is missing — create it?`, false));
+            if (createExchange) {
+                const exchangeType = options.exchangeType || (await (0, schematic_prompt_util_1.askSelect)(prompts, `Type for exchange '${exchange}'?`, TYPES, 'direct'));
+                const exOutcome = (0, broker_yaml_util_1.ensureExchange)(doc, { name: exchange, type: exchangeType });
+                (0, schematic_prompt_util_1.logOutcome)(context, `exchange '${exchange}'`, exOutcome);
+            }
+        }
+        const routingKey = (0, broker_yaml_util_1.routingKeyRequired)(doc, exchange) ? options.routingKey || name : options.routingKey;
+        const outcome = (0, broker_yaml_util_1.ensureQueue)(doc, {
+            name,
+            exchange,
+            routingKey,
+            createQueueIfNotExists: options.createIfNotExists ?? true,
+            durable: options.durable ?? true,
+            exclusive: options.exclusive ?? false,
+            autoDelete: options.autoDelete ?? false,
+            messageTtl: options.messageTtl,
+            maxLength: options.maxLength,
+            expires: options.expires,
+        }, { overwrite: options.overwrite });
+        (0, schematic_prompt_util_1.logOutcome)(context, `queue '${name}'`, outcome);
+        (0, yaml_config_util_1.writeConfigDoc)(tree, configPath, doc);
+        return tree;
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/add-queue/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-queue/index.ts"],"names":[],"mappings":";;AAoBA,oBAqDC;AAxED,gEAMmC;AACnC,0EAAyG;AACzG,gEAA0F;AAG1F,MAAM,KAAK,GAA4B,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAQhF,SAAgB,IAAI,CAAC,OAAwB;IAC3C,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;QACjD,MAAM,OAAO,GAAG,IAAA,mCAAW,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAA,+BAAO,EAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAAC,CAAC;QAEhG,MAAM,UAAU,GAAG,IAAA,iCAAc,EAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,gCAAa,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,UAAU,2BAA2B,CAAC,CAAC;QAIvF,IAAI,CAAC,IAAA,iCAAc,EAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,CAAC,MAAM,IAAA,kCAAU,EAAC,OAAO,EAAE,aAAa,QAAQ,2BAA2B,EAAE,KAAK,CAAC,CAAC,CAAC;YACtI,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,YAAY,GACf,OAAO,CAAC,YAA6B,IAAI,CAAC,MAAM,IAAA,iCAAS,EAAC,OAAO,EAAE,sBAAsB,QAAQ,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;gBAC5H,MAAM,SAAS,GAAG,IAAA,iCAAc,EAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC9E,IAAA,kCAAU,EAAC,OAAO,EAAE,aAAa,QAAQ,GAAG,EAAE,SAAS,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QAGD,MAAM,UAAU,GAAG,IAAA,qCAAkB,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAEvG,MAAM,OAAO,GAAG,IAAA,8BAAW,EACzB,GAAG,EACH;YACE,IAAI;YACJ,QAAQ;YACR,UAAU;YACV,sBAAsB,EAAE,OAAO,CAAC,iBAAiB,IAAI,IAAI;YACzD,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EACD,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACjC,CAAC;QACF,IAAA,kCAAU,EAAC,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QAEhD,IAAA,iCAAc,EAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC"}

package/schematics/add-queue/index.spec.ts

@@ -0,0 +1,75 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { parseDocument } from 'yaml';
+import { main } from './index';
+import { AddQueueOptions } from './schema';
+
+/**
+ * Invoke the factory Rule directly against a Tree (NOT SchematicTestRunner — it eagerly loads `ora`,
+ * an ESM-only module jest cannot transform here). Passing `name` makes `flagsProvided` true, so no
+ * interactive prompt is attempted.
+ */
+const ctx = { logger: { info() {}, warn() {}, error() {} } } as unknown as SchematicContext;
+
+async function run(options: AddQueueOptions, tree: Tree): Promise<Tree> {
+  const rule = main(options) as Rule;
+  const result = await (rule as (t: Tree, c: SchematicContext) => Promise<Tree>)(tree, ctx);
+  return result || tree;
+}
+
+function read(tree: Tree, path = 'config/config.yaml'): string {
+  return tree.read(path)!.toString('utf-8');
+}
+function doc(tree: Tree) {
+  return parseDocument(read(tree));
+}
+function seedConfig(): Tree {
+  const tree = Tree.empty();
+  tree.create(
+    'config/config.yaml',
+    ['# my config', 'broker:', '  exchanges:', '    - name: rlb', '      type: direct', 'topics: []', ''].join('\n'),
+  );
+  return tree;
+}
+
+describe('add-queue schematic', () => {
+  it('appends a new queue, preserving comments', async () => {
+    const tree = await run({ name: 'orders', exchange: 'rlb' }, seedConfig());
+    const queues = doc(tree).getIn(['broker', 'queues']) as any;
+    expect(queues.items.map((i: any) => String(i.get('name')))).toEqual(['orders']);
+    expect(String(queues.items[0].get('exchange'))).toBe('rlb');
+    expect(read(tree)).toContain('# my config');
+  });
+
+  it('is idempotent: re-adding the same queue leaves a single entry', async () => {
+    let tree = await run({ name: 'orders', exchange: 'rlb' }, seedConfig());
+    tree = await run({ name: 'orders', exchange: 'rlb' }, tree);
+    const queues = doc(tree).getIn(['broker', 'queues']) as any;
+    const names = queues.items.map((i: any) => String(i.get('name')));
+    expect(names.filter((n: string) => n === 'orders')).toHaveLength(1);
+  });
+
+  it('creates the missing exchange when createExchange is set', async () => {
+    const tree = await run({ name: 'jobs', exchange: 'jobs-ex', createExchange: true, exchangeType: 'topic' }, seedConfig());
+    const exchanges = doc(tree).getIn(['broker', 'exchanges']) as any;
+    const created = exchanges.items.find((i: any) => String(i.get('name')) === 'jobs-ex');
+    expect(created).toBeDefined();
+    expect(String(created.get('type'))).toBe('topic');
+  });
+
+  it('defaults routingKey to the queue name for topic exchanges', async () => {
+    const tree = await run({ name: 'jobs', exchange: 'jobs-ex', createExchange: true, exchangeType: 'topic' }, seedConfig());
+    const queue = (doc(tree).getIn(['broker', 'queues']) as any).items[0];
+    expect(String(queue.get('routingKey'))).toBe('jobs');
+  });
+
+  it('does not emit a routingKey for direct exchanges when none is given', async () => {
+    const tree = await run({ name: 'orders', exchange: 'rlb' }, seedConfig());
+    const queue = (doc(tree).getIn(['broker', 'queues']) as any).items[0];
+    expect(queue.get('routingKey')).toBeUndefined();
+  });
+
+  it('creates config.yaml when it does not exist', async () => {
+    const tree = await run({ name: 'orders', exchange: 'rlb' }, Tree.empty());
+    expect(tree.exists('config/config.yaml')).toBe(true);
+  });
+});

package/schematics/add-queue/index.ts

@@ -0,0 +1,74 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import {
+  ensureExchange,
+  ensureQueue,
+  exchangeExists,
+  ExchangeType,
+  routingKeyRequired,
+} from '../utils/broker-yaml.util';
+import { askConfirm, askSelect, askText, loadPrompts, logOutcome } from '../utils/schematic-prompt.util';
+import { findConfigYaml, readConfigDoc, writeConfigDoc } from '../utils/yaml-config.util';
+import { AddQueueOptions } from './schema';
+
+const TYPES: readonly ExchangeType[] = ['direct', 'topic', 'fanout', 'headers'];
+
+/**
+ * `add-queue <name>` — idempotent upsert of a `broker.queues[]` entry, comment-preserving.
+ * When the target exchange is missing it can create it via the ensureExchange DATA helper (never the
+ * add-exchange schematic) so there is no cross-schematic prompt ping-pong. Topic exchanges require a
+ * routingKey, so we default it to the queue name when the exchange is (or is being created as) topic.
+ */
+export function main(options: AddQueueOptions): Rule {
+  return async (tree: Tree, context: SchematicContext) => {
+    const flagsProvided = options.name !== undefined;
+    const prompts = loadPrompts(context, flagsProvided);
+
+    const name = options.name || (await askText(prompts, 'Queue name?', ''));
+    if (!name) {
+      context.logger.error('[rlb-amqp] add-queue: a name is required.');
+      return tree;
+    }
+
+    const exchange = options.exchange || (await askText(prompts, 'Bind to which exchange?', 'rlb'));
+
+    const configPath = findConfigYaml(tree, options.config);
+    const { doc, existed } = readConfigDoc(tree, configPath);
+    if (!existed) context.logger.info(`[rlb-amqp] ${configPath} not found — creating it.`);
+
+    // Create the exchange first when missing so the queue never dangles. Offer defaults to false
+    // interactively; passing --create-exchange (or its type) opts in non-interactively.
+    if (!exchangeExists(doc, exchange)) {
+      const createExchange = options.createExchange ?? (await askConfirm(prompts, `Exchange '${exchange}' is missing — create it?`, false));
+      if (createExchange) {
+        const exchangeType =
+          (options.exchangeType as ExchangeType) || (await askSelect(prompts, `Type for exchange '${exchange}'?`, TYPES, 'direct'));
+        const exOutcome = ensureExchange(doc, { name: exchange, type: exchangeType });
+        logOutcome(context, `exchange '${exchange}'`, exOutcome);
+      }
+    }
+
+    // Topic exchanges MUST carry a routingKey; default it to the queue name when unspecified.
+    const routingKey = routingKeyRequired(doc, exchange) ? options.routingKey || name : options.routingKey;
+
+    const outcome = ensureQueue(
+      doc,
+      {
+        name,
+        exchange,
+        routingKey,
+        createQueueIfNotExists: options.createIfNotExists ?? true,
+        durable: options.durable ?? true,
+        exclusive: options.exclusive ?? false,
+        autoDelete: options.autoDelete ?? false,
+        messageTtl: options.messageTtl,
+        maxLength: options.maxLength,
+        expires: options.expires,
+      },
+      { overwrite: options.overwrite },
+    );
+    logOutcome(context, `queue '${name}'`, outcome);
+
+    writeConfigDoc(tree, configPath, doc);
+    return tree;
+  };
+}

package/schematics/add-queue/schema.d.ts

@@ -0,0 +1,17 @@
+import { ExchangeType } from '../utils/broker-yaml.util';
+export interface AddQueueOptions {
+    name?: string;
+    exchange?: string;
+    routingKey?: string;
+    createIfNotExists?: boolean;
+    durable?: boolean;
+    exclusive?: boolean;
+    autoDelete?: boolean;
+    messageTtl?: number;
+    maxLength?: number;
+    expires?: number;
+    createExchange?: boolean;
+    exchangeType?: ExchangeType;
+    overwrite?: boolean;
+    config?: string;
+}

package/schematics/add-queue/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/add-queue/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../libs/rlb-nestjs-amqp/src/schematics/add-queue/schema.ts"],"names":[],"mappings":""}