@pipeline-builder/pipeline-events 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,126 @@
+# @pipeline-builder/pipeline-events
+
+📖 **[View documentation](https://mwashburn160.github.io/pipeline-builder/)**
+
+AWS Lambda handler for [Pipeline Builder](https://mwashburn160.github.io/pipeline-builder/) that ingests CodePipeline state-change events from EventBridge and forwards normalized payloads to the reporting service.
+
+> Internal workspace package. This is not imported by other packages — it is deployed as a Lambda by the CLI's `setup-events` command, which provisions the full EventBridge → SQS → Lambda stack (rule, queue, dead-letter queue, IAM, and this handler).
+
+## Responsibilities
+
+1. Receives CodePipeline (pipeline / stage / action) events delivered as an SQS batch sourced from EventBridge.
+2. Classifies each record into a normalized event type (`PIPELINE`, `STAGE`, `ACTION`) and derives status, start/completion times, run duration, and — on failures — the `errorMessage` (from the action's `execution-result.external-execution-summary`).
+3. Resolves each pipeline's tags via `codepipeline:ListTagsForResource`, cached per pipeline. The ARN and AWS account never leave AWS, so there is no masking/secret to manage. Untagged (unregistered) pipelines are skipped.
+4. Resolves the DORA **commit range** in-account for source/deploy events (Phase 4) and attaches `commitTimestamp`/`commitCount`.
+5. Posts the normalized batch (keyed by `pipelineId`) to the reporting service via `POST /api/reports/events`.
+6. After a successful batch, emits a **delivery-health** signal and **self-heals the dead-letter queue** (Phase 3).
+
+CodeBuild `Build State` events are skipped: a build project can be shared across pipelines, so there is no clean 1:1 mapping to a pipeline id.
+
+### Tag standard (pipeline-core generates → this forwarder parses)
+
+| Tag | Value | Purpose |
+|---|---|---|
+| `pb.pipeline-id` | `<platform pipelineId>` | The platform pipeline id to report against. Pipelines **without** this tag are unregistered and skipped. |
+| `pb.deploys` | `<stage>:<env>` pairs joined by `+`, e.g. `Deploy-stg:staging+Deploy-prod:production` | Declares which stages are deploys and to which environment. CodePipeline-tag-safe (`:` `+` allowed; no JSON). |
+
+The forwarder parses `pb.deploys` into a `stage → environment` map. For a `STAGE`/`ACTION` event it sets `environment` **only** when the event's stage matches a key in the map — that (and only that) marks the event as a deploy (`isDeploy` is derived server-side as `environment IS NOT NULL`). `PIPELINE` events have no stage and are never deploys.
+
+> No backward compatibility: the old `PIPELINE_EVENT_ID` and `Environment` tags are gone. Already-deployed pipelines produce no DORA data until they re-synth with the new tags.
+
+## Data forwarded to the platform
+
+The Lambda forwards **only pipeline-execution telemetry** — enough to compute
+success rates, stage/action timing, and DORA metrics. It runs **inside your AWS
+account**; the reporting service only ever receives the normalized payload below.
+
+### NOT forwarded (stays in your AWS account)
+
+- **AWS account number** — explicitly stripped from every event (`delete detail.account`).
+- **The pipeline ARN** (`arn:aws:codepipeline:<region>:<account>:<name>`) — built only as a
+  transient handle to look up the pipeline's `pb.pipeline-id` tag, then discarded; it is
+  never stored or sent.
+- **Source-revision URLs** (`revisionUrl`) — read only in-account to classify the source type
+  (CodeCommit / GitHub / Bitbucket) for commit-range resolution; not forwarded on their own.
+- **AWS credentials / IAM** and any account-identifying identifiers.
+
+The platform stores no AWS account id anywhere (schemas, JWTs, and APIs are account-id-free
+by design), so there is nothing to mask.
+
+### Forwarded payload (per event)
+
+`POST /api/reports/events` with a batch of:
+
+| Field | Type | Notes |
+|---|---|---|
+| `pipelineId` | string | The **platform** pipeline id (from the `pb.pipeline-id` tag) — not the ARN |
+| `eventSource` | `codepipeline` | |
+| `eventType` | `PIPELINE` \| `STAGE` \| `ACTION` | |
+| `status` | enum | The CodePipeline state (`SUCCEEDED`/`FAILED`/…) |
+| `idempotencyKey` | string | Deterministic dedupe key derived from the event's own identity (no PII) |
+| `executionId` | string? | CodePipeline execution GUID |
+| `stageName` / `actionName` | string? | |
+| `errorMessage` | string? | Human-readable failure summary (capped), on failures |
+| `startedAt` / `completedAt` | ISO 8601? | Event timestamps |
+| `durationMs` | number? | |
+| `commitSha` / `commitRef` | string? | Source revision — DORA deploy attribution |
+| `commitTimestamp` | ISO 8601? | Oldest-unshipped commit time for the range since the last deploy — resolved **in-account** (Phase 4). Omitted when unresolvable (reporting falls back to `unknown`) |
+| `commitCount` | number? | Number of commits (≥1) in that range. Omitted when unresolvable |
+| `environment` | string? | Set only when the event's stage is listed in the pipeline's `pb.deploys` tag (⇒ this event is a deploy) |
+| `detail` | object | The raw CodePipeline event detail **with `account` removed** — carries the execution result (log URL, error code) for drill-down |
+
+### Commit-range resolution (Phase 4, in-account)
+
+For a source/deploy event carrying a `commitSha`, the forwarder resolves the commit timestamp(s) for the range **since the last deploy of that pipeline**, entirely inside your AWS account, per source type detected from the revision URL:
+
+- **CodeCommit** → AWS SDK `codecommit:GetCommit` (walks first-parents back to the previous shipped commit).
+- **GitHub / CodeConnections-GitHub** → GitHub REST `compare` / `commits` API. Authenticated with the org's `pipeline-builder/{orgId}/github-token` secret when present (the secret name is derived from `PLATFORM_SECRET_NAME` by swapping the trailing `/platform` for `/github-token`; the value is the raw token string). Falls back to best-effort unauthenticated calls otherwise.
+- **Bitbucket** → Bitbucket REST commit API (single-commit).
+
+It emits `commitTimestamp` (oldest unshipped commit) and `commitCount`. Results are cached per commit; SCM rate limits (403/429) trigger a short cooldown; and **any** failure simply omits the fields — commit resolution never fails the batch. The last-shipped commit is tracked in-memory per warm container, so the first deploy after a cold start resolves as a single commit.
+
+### Delivery health + self-healing redrive (Phase 3)
+
+After a **successful** batch POST, the forwarder (throttled per warm container, best-effort, never failing the batch):
+
+1. POSTs a delivery-health signal to `POST /api/reports/ingest-health` `{ forwarded, dropped, lastEventAt }` so the Reports UI can show flowing / stale / dropping. `forwarded` accumulates across batches between health posts; `dropped` is the current DLQ depth snapshot; `lastEventAt` is the newest event timestamp seen.
+2. If the dead-letter queue is non-empty **and** no message-move task is already running, starts an SQS `StartMessageMoveTask` (DLQ → main queue) so retryable failures self-heal without a new AWS service. Guarded: success-gated, one-at-a-time (`ListMessageMoveTasks`), and throttled. Idempotent ingest (`idempotencyKey`) prevents double-counting on redelivery. The DLQ ARN defaults to `<main-queue-arn>-dlq` (derived from the SQS trigger ARN) and can be overridden with `EVENT_DLQ_ARN`.
+
+## Key exports
+
+| Export | Purpose |
+|---|---|
+| `handler(event: SQSEvent)` | The Lambda entry point. Parses + resolves the SQS batch and POSTs normalized events to the reporting service. |
+
+## Runtime
+
+- Lambda Node.js runtime, using the runtime-provided `@aws-sdk` clients (`client-codepipeline`, `client-secrets-manager`, and — loaded lazily only when needed — `client-codecommit` and `client-sqs`).
+- Triggered by an SQS queue fed by an EventBridge rule matching the `aws.codepipeline` source; processes events in batches and POSTs them in a single request per invocation.
+- Requires `PLATFORM_BASE_URL` (set by `setup-events`). Optional: `EVENT_DLQ_ARN` (self-healing redrive; defaults to `<main-queue-arn>-dlq`).
+- Authenticates with either `PLATFORM_TOKEN` (a JWT set directly) or `PLATFORM_SECRET_NAME` (a Secrets Manager secret holding the JWT in `password`, created via `pipeline-manager infra store-token`); the resolved token is cached across invocations.
+
+### IAM required by this handler
+
+The execution role (granted on the events stack — `pipeline-manager/src/templates/events-stack.json`) must allow:
+
+| Action | Resource | Used by |
+|---|---|---|
+| `codepipeline:ListTagsForResource` | the pipelines | Tag resolution. An `AccessDenied` here is logged as an error and **fails the batch**, so a missing grant is visible rather than silent. |
+| `secretsmanager:GetSecretValue` | `pipeline-builder/*/platform-*` | Platform JWT (auth). |
+| `secretsmanager:GetSecretValue` | `pipeline-builder/*/github-token-*` | GitHub/Bitbucket commit resolution (Phase 4). Best-effort: absent/denied ⇒ unauthenticated fallback. |
+| `codecommit:GetCommit` | the CodeCommit source repositories | CodeCommit commit resolution (Phase 4). Best-effort. |
+| `sqs:ReceiveMessage`, `sqs:DeleteMessage`, `sqs:GetQueueAttributes` | the main queue | SQS trigger + DLQ depth check. |
+| `sqs:GetQueueAttributes`, `sqs:ListMessageMoveTasks`, `sqs:StartMessageMoveTask` | the **dead-letter queue** | Self-healing redrive (Phase 3). |
+
+> The Phase 3/4 actions (`codecommit:GetCommit`, the `github-token` secret read, and the three DLQ `sqs:*` actions) are new grants required by this code — the events-stack IAM owner must add them. All Phase 3/4 paths are best-effort: a missing grant degrades gracefully (fields omitted / redrive skipped) and never fails the batch.
+
+## Development
+
+```bash
+pnpm build   # projen build (compile + lint + test + package)
+pnpm test    # run the Jest test suite
+```
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import type { SQSEvent } from 'aws-lambda';
+export declare const handler: (event: SQSEvent) => Promise<void>;