@terra-graph/conventions-aws 1.0.0-rc.1

package/dist/cjs/conventions/dataflow/rulesets.test.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const namespaces_js_1 = require("../../namespaces.js");
+const index_js_1 = require("../index.js");
+const rules_js_1 = __importDefault(require("./rules.js"));
+const rulesets_js_1 = __importDefault(require("./rulesets.js"));
+describe('dataflow convention rule sets', () => {
+    it('shoud register the dataflow semantics ruleset', () => {
+        const names = rulesets_js_1.default.names();
+        expect(names).toHaveLength(2);
+        expect(names).toEqual(expect.arrayContaining([
+            (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('cleanup')),
+            (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')),
+        ]));
+    });
+    it('shoud expand all semantic rules from the semantics rule set', () => {
+        const ruleSet = rulesets_js_1.default.resolve((0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')));
+        const phases = ruleSet.resolvePhases(rules_js_1.default);
+        expect(phases).toHaveLength(1);
+        const phaseRuleIds = phases[0].map((rule) => rule.serialize().id);
+        expect(phaseRuleIds).toContain('EdgeSemanticLegend');
+        expect(phaseRuleIds.filter((id) => id === 'EdgeDirectionSemantic').length).toBeGreaterThan(13);
+    });
+});

package/dist/cjs/conventions/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Convention = void 0;
+var Convention;
+(function (Convention) {
+    Convention["DataFlow"] = "dataflow";
+})(Convention || (exports.Convention = Convention = {}));

package/dist/cjs/conventions/index.test.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("./index.js");
+describe('Convention enum', () => {
+    it('shoud expose the dataflow convention namespace', () => {
+        expect(index_js_1.Convention.DataFlow).toBe('dataflow');
+    });
+});

package/dist/cjs/index.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@terra-graph/core");
+const base_js_1 = __importStar(require("./conventions/dataflow/profiles/base.js"));
+const dot_js_1 = __importStar(require("./conventions/dataflow/profiles/dot.js"));
+const rules_js_1 = __importDefault(require("./conventions/dataflow/rules.js"));
+const rulesets_js_1 = __importDefault(require("./conventions/dataflow/rulesets.js"));
+const AwsApiGateway_js_1 = require("./plugins/AwsApiGateway.js");
+const AwsIam_js_1 = require("./plugins/AwsIam.js");
+const AwsS3_js_1 = require("./plugins/AwsS3.js");
+const AwsSns_js_1 = require("./plugins/AwsSns.js");
+const AwsTransferFamily_js_1 = require("./plugins/AwsTransferFamily.js");
+const dot_js_2 = __importDefault(require("./rules/dot.js"));
+const general_js_1 = __importDefault(require("./rules/general.js"));
+const dot_js_3 = __importDefault(require("./rulesets/dot.js"));
+exports.default = () => ({
+    namedRules: core_1.NamedRuleRegistry.from([general_js_1.default, dot_js_2.default, rules_js_1.default]),
+    namedRuleSets: core_1.NamedRuleSetRegistry.from([dot_js_3.default, rulesets_js_1.default]),
+    profiles: new core_1.ProfileRegistry({
+        [dot_js_1.conventionDataFlowDotProfileName]: dot_js_1.default,
+        [base_js_1.conventionDataFlowBaseProfileName]: base_js_1.default,
+    }),
+    plugins: new core_1.GraphPluginRegistry({
+        [AwsApiGateway_js_1.AwsApiGateway.id]: new AwsApiGateway_js_1.AwsApiGateway(),
+        [AwsIam_js_1.AwsIamGraphPlugin.id]: new AwsIam_js_1.AwsIamGraphPlugin(),
+        [AwsS3_js_1.AwsS3.id]: new AwsS3_js_1.AwsS3(),
+        [AwsSns_js_1.AwsSns.id]: new AwsSns_js_1.AwsSns(),
+        [AwsTransferFamily_js_1.AwsTransferFamily.id]: new AwsTransferFamily_js_1.AwsTransferFamily(),
+    }),
+    supportedAdapterOperationsRegistry: {
+        DotAdapter: core_1.DotAdapter,
+        // GraphologyAdapter,
+    },
+});

package/dist/cjs/index.test.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@terra-graph/core");
+const base_js_1 = require("./conventions/dataflow/profiles/base.js");
+const dot_js_1 = require("./conventions/dataflow/profiles/dot.js");
+const rules_js_1 = __importDefault(require("./conventions/dataflow/rules.js"));
+const index_js_1 = require("./conventions/index.js");
+const index_js_2 = __importDefault(require("./index.js"));
+const namespaces_js_1 = require("./namespaces.js");
+const AwsApiGateway_js_1 = require("./plugins/AwsApiGateway.js");
+const AwsIam_js_1 = require("./plugins/AwsIam.js");
+const AwsS3_js_1 = require("./plugins/AwsS3.js");
+const AwsSns_js_1 = require("./plugins/AwsSns.js");
+const AwsTransferFamily_js_1 = require("./plugins/AwsTransferFamily.js");
+const assertRuntime = (runtime) => {
+    const { supportedAdapterOperationsRegistry, plugins, namedRules, namedRuleSets, profiles } = runtime;
+    if (!supportedAdapterOperationsRegistry ||
+        !plugins ||
+        !namedRules ||
+        !namedRuleSets ||
+        !profiles) {
+        throw new Error('Runtime provider missing expected registries');
+    }
+    return { supportedAdapterOperationsRegistry, plugins, namedRules, namedRuleSets, profiles };
+};
+describe('aws provider', () => {
+    it('shoud expose a complete runtime provider with all registrations', () => {
+        const runtime = (0, index_js_2.default)();
+        const { supportedAdapterOperationsRegistry, plugins, namedRules, namedRuleSets, profiles } = assertRuntime(runtime);
+        expect(supportedAdapterOperationsRegistry.DotAdapter).toBe(core_1.DotAdapter);
+        expect(plugins.names().sort()).toStrictEqual([AwsApiGateway_js_1.AwsApiGateway.id, AwsIam_js_1.AwsIamGraphPlugin.id, AwsS3_js_1.AwsS3.id, AwsSns_js_1.AwsSns.id, AwsTransferFamily_js_1.AwsTransferFamily.id].sort());
+        expect(namedRules.names().sort()).toEqual([
+            (0, namespaces_js_1.ruleName)('data.remove'),
+            (0, namespaces_js_1.ruleName)('log_groups.only_event_bridge'),
+            (0, namespaces_js_1.ruleName)('lambda.only_event_source_mapping'),
+            (0, namespaces_js_1.ruleName)('dot.sqs.dlq.align'),
+            (0, namespaces_js_1.ruleName)('dot.schedule.align'),
+            (0, namespaces_js_1.ruleName)('dot.iam_role.align'),
+            ...rules_js_1.default.names(),
+        ].sort());
+        expect(namedRuleSets.names().sort()).toEqual([
+            (0, namespaces_js_1.ruleSetName)('dot.sqs.dlq'),
+            (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('cleanup')),
+            (0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleSetName)('semantics')),
+        ].sort());
+        expect(profiles.names().sort()).toEqual([base_js_1.conventionDataFlowBaseProfileName, dot_js_1.conventionDataFlowDotProfileName].sort());
+    });
+    it('shoud aggregate rule registries without losing named registration count', () => {
+        const runtime = (0, index_js_2.default)();
+        const { namedRules, namedRuleSets, profiles } = assertRuntime(runtime);
+        expect(namedRules.names().length).toBe(6);
+        expect(namedRuleSets.names().length).toBe(3);
+        expect(profiles.names().length).toBe(2);
+    });
+});

package/dist/cjs/namespaces.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.conventionName = exports.profileName = exports.ruleSetName = exports.ruleName = exports.pluginId = exports.PACKAGE_NAMESPACE = void 0;
+exports.PACKAGE_NAMESPACE = '@terra-graph/conventions-aws';
+const pluginId = (pluginName) => `${exports.PACKAGE_NAMESPACE}:plugin:${pluginName}`;
+exports.pluginId = pluginId;
+const ruleName = (ruleName) => `${exports.PACKAGE_NAMESPACE}:rule:${ruleName}`;
+exports.ruleName = ruleName;
+const ruleSetName = (ruleSetName) => `${exports.PACKAGE_NAMESPACE}:ruleset:${ruleSetName}`;
+exports.ruleSetName = ruleSetName;
+const profileName = (profileName) => `${exports.PACKAGE_NAMESPACE}:profile:${profileName}`;
+exports.profileName = profileName;
+const conventionName = (conventionName, thing) => `convention:${conventionName.toString()}:${thing}`;
+exports.conventionName = conventionName;

package/dist/cjs/namespaces.test.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("./conventions/index.js");
+const namespaces_js_1 = require("./namespaces.js");
+describe('namespaces helpers', () => {
+    it('shoud prefix identifiers with the package namespace', () => {
+        expect(namespaces_js_1.PACKAGE_NAMESPACE).toBe('@terra-graph/conventions-aws');
+        expect((0, namespaces_js_1.pluginId)('aws.AwsS3')).toBe('@terra-graph/conventions-aws:plugin:aws.AwsS3');
+        expect((0, namespaces_js_1.ruleName)('data.remove')).toBe('@terra-graph/conventions-aws:rule:data.remove');
+        expect((0, namespaces_js_1.ruleSetName)('dot.sqs.dlq')).toBe('@terra-graph/conventions-aws:ruleset:dot.sqs.dlq');
+        expect((0, namespaces_js_1.profileName)('core')).toBe('@terra-graph/conventions-aws:profile:core');
+    });
+    it('shoud compose convention-aware names', () => {
+        expect((0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, 'dot')).toBe('convention:dataflow:dot');
+        expect((0, namespaces_js_1.conventionName)(index_js_1.Convention.DataFlow, (0, namespaces_js_1.ruleName)('legend'))).toBe('convention:dataflow:@terra-graph/conventions-aws:rule:legend');
+    });
+});

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/plugins/AwsApiGateway.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsApiGateway = void 0;
+const core_1 = require("@terra-graph/core");
+const namespaces_js_1 = require("../namespaces.js");
+class CompressApiGatewayResourcePath extends core_1.NodeRule {
+    constructor() {
+        super({
+            node: {
+                attr: {
+                    key: 'terraform.resource',
+                    eq: 'aws_api_gateway_rest_api',
+                },
+            },
+        });
+    }
+    apply(nodeId, _node, graph) {
+        if (!this.wasMatched(nodeId)) {
+            return graph;
+        }
+        const toRemove = [];
+        const collect = (currentNodeId) => {
+            const previous = graph.predecessors(currentNodeId);
+            if (previous.length !== 1) {
+                return;
+            }
+            const previousNodeId = previous[0];
+            const previousNode = graph.getNodeAttributes(previousNodeId);
+            if (previousNode?.terraform?.resource !== 'aws_api_gateway_resource') {
+                return;
+            }
+            toRemove.push(previousNodeId);
+            collect(previousNodeId);
+        };
+        collect(nodeId);
+        if (toRemove.length === 0) {
+            return graph;
+        }
+        const closestResourceNodeId = toRemove[0];
+        const furthestResourceNodeId = toRemove[toRemove.length - 1];
+        const closestResourceNode = graph.getNodeAttributes(closestResourceNodeId);
+        if (!closestResourceNode) {
+            return graph;
+        }
+        const resourcePath = toRemove
+            .map((resourceNodeId) => {
+            const resourceNode = graph.getNodeAttributes(resourceNodeId);
+            return resourceNode?.terraform?.name ?? String(resourceNodeId);
+        })
+            .join('/');
+        const resourceAddress = `aws_api_gateway_resource.${resourcePath}`;
+        const compressedNodeId = (0, core_1.tgNodeIdFrom)('resource', resourceAddress);
+        let updated = graph.setNodeAttributes(compressedNodeId, {
+            ...closestResourceNode,
+            terraform: {
+                ...closestResourceNode.terraform,
+                kind: 'resource',
+                address: resourceAddress,
+                resource: 'aws_api_gateway_resource',
+                name: resourcePath,
+            },
+        });
+        const outEdges = graph.outEdges(closestResourceNodeId);
+        for (const outEdgeId of outEdges) {
+            const targetId = graph.edgeTarget(outEdgeId);
+            const edgeAttributes = graph.getEdgeAttributes(outEdgeId);
+            const redirectedEdgeId = (0, core_1.edgeIdFrom)(compressedNodeId, targetId, `apigateway:compress:out:${outEdgeId}`);
+            updated = updated.setEdge(redirectedEdgeId, compressedNodeId, targetId, edgeAttributes);
+        }
+        const inEdges = graph.inEdges(furthestResourceNodeId);
+        for (const inEdgeId of inEdges) {
+            const sourceId = graph.edgeSource(inEdgeId);
+            const edgeAttributes = graph.getEdgeAttributes(inEdgeId);
+            const redirectedEdgeId = (0, core_1.edgeIdFrom)(sourceId, compressedNodeId, `apigateway:compress:in:${inEdgeId}`);
+            updated = updated.setEdge(redirectedEdgeId, sourceId, compressedNodeId, edgeAttributes);
+        }
+        for (const resourceNodeId of toRemove) {
+            updated = updated.removeNode(resourceNodeId);
+        }
+        return updated;
+    }
+}
+class AwsApiGateway extends core_1.GraphPlugin {
+    static id = (0, namespaces_js_1.pluginId)(`aws.${AwsApiGateway.name}`);
+    constructor() {
+        super(AwsApiGateway.id);
+    }
+    build(_input) {
+        return {
+            phases: [
+                {
+                    phase: 'main',
+                    rules: [
+                        new core_1.RemoveNode({
+                            node: {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    in: [
+                                        'aws_api_gateway_integration_response',
+                                        'aws_api_gateway_method_response',
+                                        'aws_api_gateway_method_settings',
+                                        'aws_api_gateway_account',
+                                        'aws_api_gateway_model',
+                                        'aws_wafv2_web_acl_logging_configuration',
+                                    ],
+                                },
+                            },
+                        }),
+                    ],
+                },
+                { phase: 'main', rules: [new CompressApiGatewayResourcePath()] },
+                {
+                    phase: 'main',
+                    rules: [
+                        new core_1.EdgeReverse({
+                            edge: {
+                                from: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_rest_api',
+                                    },
+                                },
+                                to: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_resource',
+                                    },
+                                },
+                            },
+                        }),
+                        new core_1.EdgeReverse({
+                            edge: {
+                                from: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_method',
+                                    },
+                                },
+                                to: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_integration',
+                                    },
+                                },
+                            },
+                        }),
+                        new core_1.EdgeReverse({
+                            edge: {
+                                from: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_resource',
+                                    },
+                                },
+                                to: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_api_gateway_method',
+                                    },
+                                },
+                            },
+                        }),
+                        new core_1.EdgeReverse({
+                            edge: {
+                                from: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_wafv2_web_acl',
+                                    },
+                                },
+                                to: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_wafv2_web_acl_association',
+                                    },
+                                },
+                            },
+                        }),
+                        new core_1.EdgeReverse({
+                            edge: {
+                                from: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_wafv2_ip_set',
+                                    },
+                                },
+                                to: {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        eq: 'aws_wafv2_web_acl',
+                                    },
+                                },
+                            },
+                        }),
+                    ],
+                },
+                {
+                    phase: 'main',
+                    rules: [
+                        new core_1.ConvertNodeToEdge({
+                            node: {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    in: [
+                                        'aws_api_gateway_deployment',
+                                        'aws_api_gateway_method',
+                                        'aws_wafv2_web_acl_association',
+                                    ],
+                                },
+                            },
+                        }),
+                    ],
+                },
+            ],
+        };
+    }
+}
+exports.AwsApiGateway = AwsApiGateway;