signalk-container-helper 0.1.0

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 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,288 @@
+# signalk-container-helper
+
+Helper library for [Signal K](https://signalk.org) plugin developers whose plugins run
+containers through the [signalk-container](https://github.com/dirkwa/signalk-container)
+plugin.
+
+Every containerized Signal K plugin ends up hand-writing the same integration code:
+polling for the container manager, validating tags, calling `ensureRunning`, waiting
+for the app inside the container to answer HTTP, registering for update detection,
+mounting `/api/update/check` + `apply` routes, and stopping cleanly. This library
+packages those patterns — extracted from `signalk-backup`, `mayara-server-signalk-plugin`,
+`signalk-doctor`, and `signalk-updater` — into a small, typed, zero-dependency API.
+
+See [SPEC.md](SPEC.md) for the full design rationale.
+
+## Install
+
+```bash
+npm install signalk-container-helper
+```
+
+Declare the signalk-container relationship in your plugin's `package.json` — do **not**
+add signalk-container to `dependencies` or `peerDependencies` (its prerelease
+versioning breaks npm semver ranges):
+
+```json
+{
+  "signalk": {
+    "requires": ["signalk-container"]
+  }
+}
+```
+
+Requires **Node ≥ 24**. This library is published as an **ES module** (`import`, not
+`require`); consumers must be ESM too.
+
+At **runtime** it works with signalk-container ≥ 1.6.0 — newer manager features
+(`recreate`, `getLogs`, …) are feature-detected with graceful fallbacks. Its
+**type contract** is validated against **signalk-container ≥ 1.23.2** (1.23.0
+first published the `signalk-container/types` entrypoint; 1.23.1 added the
+update-service types; 1.23.2 completed their option types); this is a dev-only
+check and imposes no dependency on your plugin.
+
+## Quick start: a managed container
+
+For plugins that own their container's lifecycle (the `signalk-backup` /
+`mayara` archetype):
+
+```ts
+import { ManagedContainer, startSafely } from "signalk-container-helper";
+
+export default function plugin(app) {
+  let container: ManagedContainer | null = null;
+  let settings = null;
+
+  const plugin = {
+    id: "signalk-myservice",
+    name: "My Service",
+
+    // Signal K does NOT await start() — keep it synchronous and let
+    // startSafely catch and report async failures.
+    start(rawConfig) {
+      settings = { ...SCHEMA_DEFAULTS, ...rawConfig }; // SK doesn't seed defaults
+
+      container = new ManagedContainer({
+        app,
+        pluginId: "signalk-myservice",
+        name: "myservice", // unprefixed; runtime name is sk-myservice
+        image: "ghcr.io/example/myservice",
+        defaultTag: "latest",
+        buildConfig: (tag) => ({
+          image: "ghcr.io/example/myservice",
+          tag,
+          signalkAccessiblePorts: [9000], // let signalk-container wire networking
+          signalkDataMount: "/data", // plugin data dir, deployment-agnostic
+          env: { LOG_LEVEL: "info" },
+          restart: "unless-stopped",
+          resources: {
+            cpus: 1,
+            memory: "512m",
+            memorySwap: "512m",
+            pidsLimit: 100,
+          },
+        }),
+        readiness: { port: 9000, path: "/api/health" },
+        updates: {
+          versionSource: { githubReleases: "example/myservice" },
+          currentTag: () => settings?.imageTag ?? "latest",
+        },
+      });
+
+      startSafely(app, async () => {
+        const { address } = await container.start(settings.imageTag);
+        // address = "http://127.0.0.1:9000" — the app answered /api/health
+        app.setPluginStatus("Running");
+      });
+    },
+
+    async stop() {
+      await container?.stop(); // unregister updates + stop (not remove); never throws
+      app.setPluginStatus("Stopped");
+    },
+
+    registerWithRouter(router) {
+      // GET  /plugins/signalk-myservice/api/update/check
+      // POST /plugins/signalk-myservice/api/update/apply   { tag?: string }
+      container?.registerUpdateRoutes(router, {
+        onApplied: (requestedTag) => {
+          // persist the REQUESTED tag (e.g. "auto") so auto-tracking survives
+          settings.imageTag = requestedTag;
+          app.savePluginOptions(settings, () => undefined);
+        },
+      });
+    },
+
+    schema: () => SCHEMA,
+  };
+  return plugin;
+}
+```
+
+What `start()` does for you, in order:
+
+1. **Waits for the manager** — polls `globalThis.__signalk_containerManager`
+   (plugins start alphabetically; signalk-container may load after you), then waits
+   for runtime detection to settle via `whenReady()`. Distinct, actionable errors for
+   "signalk-container missing" vs "no podman/docker found".
+2. **Validates the tag** against `/^[a-zA-Z0-9._-]+$/` and applies your
+   `resolveTag` mapping (e.g. `"auto"` → a pinned tested version).
+3. **Self-heals** — if the live container's image differs from the desired
+   `image:tag`, it is `recreate`d immediately (signalk-container ≥ 1.12.0) instead of
+   waiting on drift detection.
+4. **Reconciles** via `ensureRunning(name, buildConfig(tag))` — declarative and
+   idempotent; signalk-container recreates on config drift. No hash files.
+5. **Registers for update detection** (non-fatal on failure).
+6. **Resolves the address** for your `readiness.port` — with a fallback that parses
+   `listContainers()` port bindings, because `resolveContainerAddress` can return a
+   stale port after recreates.
+7. **Waits for HTTP readiness** — "container running" ≠ "app ready".
+
+Progress is reported through `app.setPluginStatus`; the final "Running" message is
+yours to set. Fatal failures throw a typed `ContainerHelperError` _after_ reporting
+via `app.setPluginError` — `startSafely` knows not to double-report.
+
+## Quick start: an adopted container
+
+For plugins whose container is managed elsewhere (systemd Quadlet, external host) —
+the `signalk-doctor` / `signalk-updater` archetype. Register it for update
+notifications and probe its health over HTTP, but never touch its lifecycle:
+
+```ts
+import {
+  AdoptedContainer,
+  probeHttpHealth,
+  startSafely,
+} from "signalk-container-helper";
+
+const ENGINE_URL = "http://127.0.0.1:3004";
+
+const adopted = new AdoptedContainer({
+  app,
+  pluginId: "signalk-mytool",
+  containerName: "mytool-server",
+  image: "ghcr.io/example/mytool-server",
+  currentTag: "latest", // what the deployment pins (OperatorIntent)
+  currentVersion: async () => {
+    // the app's honest version (RuntimeIdentity)
+    const res = await fetch(`${ENGINE_URL}/api/health`);
+    return ((await res.json()) as { version?: string }).version ?? null;
+  },
+  versionSource: { githubReleases: "example/mytool-server" }, // LatestAvailable
+  checkInterval: "24h",
+});
+
+// in start():
+startSafely(app, async () => {
+  // false + setPluginError when unavailable; never throws. Stop here so we
+  // don't overwrite that error with a health status below.
+  if (!(await adopted.register())) return;
+
+  const probe = await probeHttpHealth(`${ENGINE_URL}/api/health`);
+  if (!probe.reachable) {
+    app.setPluginError(
+      "mytool-server is not reachable — is its service running?",
+    );
+  } else if (probe.slowMs) {
+    // Signal K has no warning tier — report slow-but-healthy as a status
+    app.setPluginStatus(
+      `Reachable but slow (${probe.slowMs}ms) — likely disk I/O contention`,
+    );
+  } else {
+    app.setPluginStatus("Running");
+  }
+});
+
+// in stop():
+adopted.unregister();
+```
+
+Why not `manager.getState()` for health? signalk-container namespace-prefixes the
+containers it manages (`sk-<name>`); externally-managed peers don't carry the prefix,
+so the manager can't see them — and "running" isn't "healthy" anyway.
+
+## API overview
+
+| Export                          | Purpose                                                                                                                                                                                                                                                                                  |
+| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ManagedContainer`              | Full lifecycle: `start`, `stop`, `applyUpdate`, `checkForUpdate`, `getState`, `getInfo`, `resolveAddress`, `getLogs`, `registerUpdateRoutes`                                                                                                                                             |
+| `AdoptedContainer`              | Update registration + checks for externally-managed containers                                                                                                                                                                                                                           |
+| `getContainerManager()`         | Read the `globalThis.__signalk_containerManager` global                                                                                                                                                                                                                                  |
+| `waitForContainerManager(opts)` | Two-phase wait (manager present → runtime settled); returns `{ manager, runtime }` so the two failure modes get distinct messages                                                                                                                                                        |
+| `waitForHttpReady(url, opts)`   | Poll until 2xx or deadline (throws)                                                                                                                                                                                                                                                      |
+| `probeHttpHealth(url, opts)`    | Retrying liveness probe with slow-response detection (never throws)                                                                                                                                                                                                                      |
+| `fetchWithTimeout(url, opts)`   | `fetch` with an `AbortController` timeout                                                                                                                                                                                                                                                |
+| `startSafely(app, fn)`          | Sync wrapper for async plugin startup — Signal K does not await `start()`                                                                                                                                                                                                                |
+| `isValidImageTag(tag)`          | Tag guard (`IMAGE_TAG_PATTERN`)                                                                                                                                                                                                                                                          |
+| `errMsg(err)`                   | Normalize unknown errors to strings                                                                                                                                                                                                                                                      |
+| `ContainerHelperError`          | Typed error with `code` and `reported`                                                                                                                                                                                                                                                   |
+| Types                           | Local mirror of signalk-container's public API — `ContainerManagerApi`, `ContainerConfig`, `EnsureRunningOptions`, `UpdateServiceApi`, … — verified at build time against `signalk-container/types` (≥ 1.23.2) so it never silently drifts. Feature-detected members stay optional here. |
+
+### Error codes
+
+`ContainerHelperError.code` values thrown by `start()` / `applyUpdate()`:
+
+| Code                  | Meaning                                                                        |
+| --------------------- | ------------------------------------------------------------------------------ |
+| `manager-unavailable` | signalk-container never published its API within the budget                    |
+| `no-runtime`          | Manager present, but no podman/docker was detected                             |
+| `invalid-tag`         | Tag failed the `IMAGE_TAG_PATTERN` guard                                       |
+| `address-unresolved`  | No host:port could be found for the readiness port                             |
+| `not-ready`           | The app never answered its health URL before the deadline                      |
+| `recreate-limbo`      | Legacy update path removed the container but recreation failed — retry applies |
+
+All errors thrown by the helpers have already been surfaced through
+`app.setPluginError` (`reported: true`), so `startSafely` won't report them twice.
+
+### Version compatibility
+
+The helpers feature-detect newer signalk-container capabilities:
+
+| Capability                    | Floor  | Fallback behavior                                            |
+| ----------------------------- | ------ | ------------------------------------------------------------ |
+| `whenReady()`                 | 1.6.0  | polls `getRuntime()`                                         |
+| `getLogs()`                   | 1.7.0  | `getLogs()` returns `null`                                   |
+| `recreate()`                  | 1.12.0 | self-heal skipped; updates use pull → remove → ensureRunning |
+| `ContainerConfig.healthcheck` | 1.14.0 | ignored by older versions                                    |
+| `ContainerConfig.ulimits`     | 1.17.0 | ignored by older versions                                    |
+
+## Design rules inherited from the reference plugins
+
+- **Runtime-only coupling.** Never import signalk-container; reach it through the
+  global. The types shipped here are a mirror, not a dependency.
+- **Never throw out of `start()`.** The server doesn't await it — use `startSafely`.
+- **Stop, don't remove.** `stop()` leaves the container in place so re-enabling the
+  plugin restarts it instantly without a pull.
+- **Offline is normal.** Boats at sea lose connectivity; nothing here converts a
+  network failure into a fatal error.
+- **The user owns updates.** Update detection notifies; applying is an explicit
+  action (`applyUpdate` / the POST route). Persist the _requested_ tag (e.g.
+  `"auto"`), not the resolved version, so auto-tracking survives restarts.
+
+## Development
+
+```bash
+npm install
+npm test          # typecheck the type contract, then vitest (fully mocked — no containers needed)
+npm run build     # tsc → dist/
+npm run format    # prettier --write + eslint --fix
+npm run ci-lint   # eslint + prettier --check (what CI runs)
+```
+
+CI (`.github/workflows/ci.yml`) runs `ci-lint`, `build`, and `test` on every push and pull request.
+
+## Releasing
+
+This library is distributed through **npm with semver** — consumers `npm install signalk-container-helper` and pin a range (`^1.0.0`); they never build against `master`. `master` is the development trunk and may be mid-change without affecting anyone.
+
+Releases are tag-triggered (`.github/workflows/publish.yml` fires on `v*` tags):
+
+1. Bump `version` in `package.json`, commit, and merge to `master`.
+2. Tag `vX.Y.Z` and push the tag.
+3. The workflow builds, tests, creates a GitHub Release (auto-generated notes), and runs `npm publish --provenance` (prereleases `-beta.`/`-rc.` publish under the `beta` dist-tag).
+
+Publishing requires an `NPM_TOKEN` repository secret with publish rights to the package.
+
+## License
+
+Apache-2.0