@bjorntech/alchemy-azure 0.2.0-beta.57

package/ARCHITECTURE.md

@@ -0,0 +1,170 @@
+# Architecture
+
+This document explains how `@bjorntech/alchemy-azure` is organised and why. It's aimed at contributors and at anyone who wants to add a new Azure resource type.
+
+For an end-user view of the package, see the [README](./README.md). For the upstream v2 model this package implements, see [v2.alchemy.run](https://v2.alchemy.run/).
+
+## File layout
+
+```
+src/
+  index.ts                      ← public re-exports
+  Providers.ts                  ← the providers() layer (Provider.collection + AuthProvider + Credentials)
+  AuthProvider.ts               ← AzureAuth (env + stored) + resolveFromEnv / resolveFromStored
+  Credentials.ts                ← AzureCredentials Context.Service + fromAuthProvider() bridge
+  Clients.ts                    ← Azure SDK client factory keyed off AzureCredentials
+  Errors.ts                     ← AzureError tagged error + isNotFound / isAlreadyExists
+  Internal.ts                   ← physicalName / resourceGroupName / requireLocation helpers
+
+  ResourceGroup.ts              ← one file per resource type
+  StorageAccount.ts
+  BlobContainer.ts
+  ContainerAppEnvironment.ts
+  ContainerRegistry.ts
+  ContainerImage.ts
+  ContainerApp.ts               ← experimental Platform host
+  MoreResources.ts              ← bulk file containing the simpler "shape" resources
+
+  BlobState.ts                  ← Azure Blob-backed state store (alternative to local state)
+
+test/
+  *.test.ts                     ← Bun test suites
+```
+
+## How a resource is wired
+
+Every resource follows the same five-step contract from [v2.alchemy.run/concepts/provider](https://v2.alchemy.run/concepts/provider):
+
+1. **Props + Attributes types** describe inputs and outputs.
+2. **`Resource<T>(type)`** constructs the typed handle.
+3. **`Provider.effect(R, Effect.gen(...))`** wraps the lifecycle methods.
+4. **`R.Provider.of({ stables, diff, read, reconcile, delete })`** types each method against the resource's props/attrs.
+5. The provider Layer is added to `Provider.collection([...])` in `src/Providers.ts` and `Layer.provide`d to it.
+
+Concretely, a minimal resource looks like this:
+
+```ts
+// MyResource.ts
+export interface MyResourceProps extends BaseProps { /* ... */ }
+export type MyResource = Resource<"Azure.MyResource", MyResourceProps, Attrs<{ ... }>, never, Providers>;
+export const MyResource = Resource<MyResource>("Azure.MyResource");
+
+export const MyResourceProvider = () =>
+  Provider.effect(
+    MyResource,
+    Effect.gen(function* () {
+      const clients = yield* makeAzureClients;
+      const nameOf = (id, props) => physicalName(id, props.name, { maxLength: 64 });
+
+      return MyResource.Provider.of({
+        stables: ["name", "resourceGroupName", "resourceId"],
+        diff: Effect.fnUntraced(function* ({ olds, news, output }) { /* replace identity, update mutable */ }),
+        read: Effect.fnUntraced(function* ({ id, olds, output }) { /* ... */ }),
+        reconcile: Effect.fnUntraced(function* ({ id, news }) { /* ... */ }),
+        delete: Effect.fnUntraced(function* ({ olds, output, session }) { /* ... */ }),
+      });
+    }),
+  );
+```
+
+Then register it in `src/Providers.ts`:
+
+```ts
+Provider.collection([..., MyResource])
+  .pipe(Layer.provide(Layer.mergeAll(..., MyResourceProvider())))
+```
+
+…and re-export from `src/index.ts`.
+
+## Conventions
+
+### Physical names
+
+Use `Internal.physicalName(id, props.name, options)` to derive a deterministic Azure-safe name. The defaults respect Azure's per-service character set (lowercase, length, allowed characters). When the user supplies an explicit `name` it's used verbatim; otherwise we derive `{stack}-{stage}-{logical-id}-{instance-id}` and apply optional sanitization.
+
+The `nameOf` closure is reused by `diff` (to detect identity changes that should trigger replacement) and by `read` (to find the live resource when adopting from cloud). Diff only returns `replace` for durable identity changes such as name, parent resource group, region, parent resource, or Azure-documented create-time properties. Mutable desired-state changes should return `update` so `reconcile` runs.
+
+When mutability is unclear, verify against Microsoft Learn ARM template references, Azure REST API request schemas, and Terraform AzureRM `ForceNew` behavior. Prefer conservative replacement for create-time or conditionally immutable Azure properties unless the provider implements a specific safe migration path.
+
+### Ownership
+
+Azure's API has no built-in concept of "this resource belongs to my IaC tool", so we do it via tags:
+
+- `withAlchemyTags(id, props.tags)` adds `alchemy:logical-id: <id>` to every resource we create.
+- `hasAlchemyTags(id, resource.tags)` checks the tag matches the logical ID we expect.
+- `read` brands foreign-owned attributes with `Unowned(attrs)` from `alchemy/AdoptPolicy`. The engine then refuses to take them over unless the user passes `--adopt`.
+- During state recovery (`output` is defined), still verify the current Azure ownership marker. If a previously owned resource was deleted and recreated out-of-band without our marker, return `Unowned(attrs)` from `read` or fail update reconciliation unless the user explicitly adopts it.
+
+`BlobContainer` uses the `alchemyLogicalId` blob metadata key instead of tags, since blob containers don't support Azure resource tags.
+
+### Reconcile shape
+
+Always **observe → ensure → sync → return**:
+
+- **Observe**: try to GET the resource. If 404, treat as "needs create".
+- **Ensure**: create-or-update. Most Azure ARM clients expose `beginCreateOrUpdateAndWait` which is idempotent.
+- **Sync**: not all of Azure is convergent on a single `createOrUpdate`. For aspects that aren't (e.g. role assignments, custom domains), check observed state and apply only the delta.
+- **Return**: build the `Attributes` object from the response.
+
+Never branch the reconcile body on `output === undefined`. That just renames the old `create`/`update` split. A correct reconcile produces the right cloud state regardless of starting point.
+
+### Errors
+
+Wrap Azure SDK calls with `Effect.tryPromise({ try, catch })`, mapping the `catch` to `azureError({ operation, resource, cause })`. This produces a tagged `AzureError` with `statusCode` / `code` extracted from the SDK error, which downstream code can match with `Effect.catchTag("AzureError", ...)`.
+
+For 404 handling on `read` and `delete`, use `Effect.catchIf(isNotFound, ...)`. For "already exists" race conditions, use `isAlreadyExists`.
+
+### Secrets
+
+Anything that's a credential — storage keys, connection strings, registry passwords, client secrets — is wrapped in `Redacted<string>` from `effect/Redacted`. The wrapper prevents accidental logging. Unwrap with `Redacted.value(x)` only at the SDK boundary.
+
+### Clients
+
+`makeAzureClients` (in `Clients.ts`) is an Effect that yields `AzureCredentials` and constructs every Azure SDK client we need. Each provider's outer `Effect.gen` calls `yield* makeAzureClients` once at layer-construction time, so the clients are created once per stack and shared across `reconcile` / `read` / `delete` invocations.
+
+### Auth
+
+`AzureAuth` registers itself in the `AuthProviders` registry under the name `"Azure"` via `AuthProviderLayer`. Two methods:
+
+- **`env`**: reads `AZURE_*` environment variables. Returns `servicePrincipal` when tenant + client + secret are all set; otherwise returns `default` (the SDK's `DefaultAzureCredential` chain).
+- **`stored`**: reads `~/.alchemy/credentials/{profile}/azure-stored.json` written by `alchemy login`. Same fallback logic.
+
+`Credentials.fromAuthProvider()` is the bridge: it loads the profile, reads credentials via the registry, and yields an `AzureCredentialsService` (which contains a real `TokenCredential` ready for the SDK clients).
+
+The two pure helpers `resolveFromEnv()` and `resolveFromStored(creds)` are exported so they can be unit-tested without standing up the full `AuthProvider` layer.
+
+## Testing
+
+Tests live in `test/` and run with `bun test`. They fall into three categories:
+
+1. **Unit tests** for pure helpers — `resolveFromEnv`, `resolveFromStored`, `azureError`, `physicalName`. These run with no I/O.
+2. **In-memory state tests** for `BlobState.ts` using a `MemoryBlobContainer` fake.
+3. **Type-only tests** in `test/types.test.ts` that build a sample stack to ensure resources compose correctly.
+
+Live cloud tests (real Azure resources) are **not** included. The upstream `alchemy/Test/Bun` harness can be used to add them later — see [v2.alchemy.run/concepts/testing](https://v2.alchemy.run/concepts/testing).
+
+When mocking environment variables, use `ConfigProvider.fromEnv({ env })` and provide it as a Layer. `process.env` mutation does not propagate to Effect's `Config.string` reads.
+
+## Adding a new resource
+
+1. Pick the right Azure SDK package and add it to `dependencies` in `package.json` if it isn't already there.
+2. Create `src/MyResource.ts` following the template above. For "shape" resources that don't need anything special, you can add them to `src/MoreResources.ts` instead.
+3. Add the SDK client to `Clients.ts`.
+4. Register the provider in `src/Providers.ts` (`Provider.collection([...])` and `Layer.mergeAll(...)`).
+5. Re-export from `src/index.ts`.
+6. Add a row to the resource list in `README.md`.
+7. If the resource has non-trivial props, add a unit test that exercises `physicalName` / `diff` / `read` paths.
+
+## Tracking upstream alchemy
+
+This package is exact-pinned to a specific `alchemy@2.0.0-beta.X` because v2 is still in beta and breaking changes happen between betas. To upgrade:
+
+1. Bump `peerDependencies.alchemy` and `devDependencies.alchemy` in `package.json` to the new beta.
+2. Run `bun install`.
+3. Run `bun run check` and `bun test`. Fix any new type errors or breakages.
+4. Bump `@bjorntech/alchemy-azure`'s own version to match: `0.1.0-beta.36` for `alchemy@2.0.0-beta.36`, etc.
+5. Update the compatibility matrix in `README.md`.
+6. Add a `CHANGELOG.md` entry describing what changed and any required migration.
+7. Tag and publish.
+
+When `alchemy` cuts a stable `2.0.0`, this package will graduate to `0.1.0` (or `1.0.0`) with a permissive `^2.0.0` peerDep range.

package/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to `@bjorntech/alchemy-azure` are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the package follows the alchemy beta line — see [README › Compatibility](./README.md#compatibility).
+
+## [Unreleased]
+
+## [0.2.0-beta.57] - 2026-06-27
+
+### Added
+
+- Long-running "sign of life" heartbeat: the slowest resources now log a progress
+  message to stderr every 60 seconds while an operation is in flight, so slow Azure
+  provisioning and teardown no longer look like a hung process. Applied selectively to
+  Container Apps managed environment, Container App, Cosmos DB account, SQL server, and
+  virtual machine create/delete paths; fast resources stay quiet.
+
+### Fixed
+
+- Blob container create/update no longer fails at runtime with
+  `undefined is not an object (evaluating 'this.client')`. The reconcile path aliased
+  the Azure SDK method and invoked it unbound, detaching `this`; it now calls
+  `blobContainers.create` (an idempotent create-or-update PUT) directly so the SDK
+  method keeps its binding.
+
+## [0.1.1-beta.57] - 2026-06-26
+
+### Fixed
+
+- Container App `Redacted` environment variables now use Container Apps secrets plus `secretRef` entries instead of writing plaintext values into normal environment variable configuration.
+- Azure SDK lifecycle calls now consistently wrap failures as tagged `AzureError` values with operation/resource context.
+- Key Vault tenant changes, including omitted-to-explicit changes, now plan replacement.
+- Tightened Azure diff semantics against public ARM documentation and Terraform AzureRM replacement behavior: create-time fields such as storage account kind, public IP SKU/version/zones, service bus tier, Cosmos DB kind/free tier, SQL version/collation, Key Vault tenant/soft-delete retention, App Service plan OS kind, container instance runtime shape, and VM OS identity/image/network credentials now plan replacement instead of unsafe in-place updates.
+- Hardened the release workflow to publish only from `main`, use deterministic package tarballs, and create/verify GitHub releases.
+
+## [0.1.0-beta.57] - 2026-06-21
+
+### Changed
+
+- Updated compatibility target to `alchemy@2.0.0-beta.57` and Effect `>=4.0.0-beta.84`.
+- Azure SDK clients are now provided through an injectable `AzureClients` Effect
+  service (with `AzureClientsLive` for production), so provider lifecycles can
+  be unit-tested with an in-memory fake. Public API is unchanged.
+
+### Fixed
+
+- `isNotFound` / `isAlreadyExists` now unwrap the `cause` chain. `Effect.tryPromise(thunk)` wraps a rejected promise in `UnknownError`, so the previous top-level checks never matched a 404/409, which broke idempotent `read` / `delete` paths and `AzureError` status extraction for not-found resources. `azureError` now also extracts `statusCode` / `code` from the wrapped cause.
+
+### Added
+
+- Provider lifecycle test suite covering reconcile/read/delete/diff and attribute mapping for every non-experimental resource, plus a coverage-floor gate (`coverage:check`) wired into CI and `prepublishOnly`.
+- Repository hygiene: `SECURITY.md`, `CONTRIBUTING.md`, `env.example`, `.editorconfig`, Dependabot config, and issue/PR templates.
+
+## [0.1.0-beta.35] - 2026-06-20
+
+Tested against `alchemy@2.0.0-beta.35`.
+
+### Added
+
+- Azure resource providers: `ResourceGroup`, `StorageAccount`, `BlobContainer`, `UserAssignedIdentity`, `VirtualNetwork`, `NetworkSecurityGroup`, `PublicIPAddress`, `CognitiveServices`, `ServiceBus`, `CosmosDBAccount`, `SqlServer`, `SqlDatabase`, `KeyVault`, `AppServicePlan`, `AppService`, `FunctionApp`, `StaticWebApp`, `ContainerInstance`, `ContainerAppEnvironment`, `ContainerRegistry`, `ContainerImage`, `ContainerApp` (experimental Platform host), `VirtualMachine`.
+- `Azure.providers()` layer bundling every provider, the `AzureAuth` registration, and credential resolution.
+- `Azure.blobState({ ... })` for using an existing Azure Blob container as the Alchemy state store.
+- `AzureAuth` AuthProvider with `env` and `stored` methods. `alchemy login` walks users through configuring a Service Principal interactively; CI defaults to `env`.
+- Tagged `AzureError` (via `Schema.TaggedErrorClass`) wrapping all Azure SDK failures inside provider lifecycle methods. Carries `operation`, `resource`, `statusCode`, `code`, and the original `cause` (with stack via `Schema.DefectWithStack`). Match with `Effect.catchTag("AzureError", ...)` inside custom resources.
+- `resolveFromEnv()` and `resolveFromStored(creds)` exported as pure helpers for unit testing credential resolution without standing up the full layer.
+- Tag-based ownership (`alchemy:logical-id`) for safe adoption — foreign-owned resources surface as `Unowned(attrs)` and require `--adopt` to take over.
+- Secrets (storage keys, connection strings, registry passwords, client secrets) returned as `Redacted<string>`.
+
+### Notes
+
+- `peerDependencies.alchemy` is exact-pinned to the alchemy v2 beta this release was tested against. `peerDependencies.effect` accepts the tested Effect beta line or stable Effect 4.
+- `ContainerApp` is marked experimental — its `Platform` integration with the upstream v2 binding model is still evolving.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 Support. 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 support.
+
+   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 2025 Björn Tech AB
+
+   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.