diff --git a/.github/workflows/mcp-release-please.yml b/.github/workflows/mcp-release-please.yml index 79b8ee76c0..835694c25d 100644 --- a/.github/workflows/mcp-release-please.yml +++ b/.github/workflows/mcp-release-please.yml @@ -17,10 +17,11 @@ name: Package Release Please # targets/workflows, and bundling them would work against this repo's small-focused-PR convention. # # linked-versions plugin, group "engine-and-dependents" (release-please-config.json) -- the -# exception to the above: packages/loopover-mcp and packages/loopover-miner both carry a REAL -# runtime `dependencies` entry on packages/loopover-engine, so they are not actually independent of -# it. The node-workspace plugin bumps a dependent's `@loopover/engine` version range the moment -# engine's own version changes, but under plain separate-pull-requests: true that bump lands on the +# exception to the above: packages/loopover-mcp and packages/loopover-miner both carry REAL runtime +# `dependencies` entries on packages/loopover-engine AND (since #9749) packages/loopover-contract, +# so they are not actually independent of either. The node-workspace plugin bumps a dependent's +# `@loopover/engine` / `@loopover/contract` version range the moment that package's own version +# changes, but under plain separate-pull-requests: true that bump lands on the # dependent's OWN separate branch/PR -- meaning the dependent's package.json ends up requiring an # engine version that exists NOWHERE (not locally on that branch, since engine's bump lives on a # different unmerged branch; not on npm either, since it hasn't published yet). `npm ci` then fails @@ -30,12 +31,15 @@ name: Package Release Please # NOT override separate-pull-requests -- verified against release-please's manifest.ts and # docs/manifest-releaser.md: separate-pull-requests is enforced as the final PR-splitting decision # regardless of what plugins attempt internally). linked-versions is the mechanism that actually -# overrides per-component isolation, but ONLY for the named `components` in its group: engine's new -# version and its dependents' bumped ranges land together in ONE PR/commit, so npm workspaces -# resolves the dependency from the LOCAL checkout (always satisfies the range, regardless of npm -# registry publish timing or ordering) instead of hitting the ETARGET race. packages/loopover-ui-kit -# has no dependency edge to any other package here and is not in the group, so it keeps its fully -# independent release cadence untouched. +# overrides per-component isolation, but ONLY for the named `components` in its group: the +# prerequisite's new version and its dependents' bumped ranges land together in ONE PR/commit, so +# npm workspaces resolves the dependency from the LOCAL checkout (always satisfies the range, +# regardless of npm registry publish timing or ordering) instead of hitting the ETARGET race. +# `contract` is in the group for exactly the same reason engine is, and NOT because it is +# "published alongside" them: membership tracks the dependency EDGE, not release cadence. +# packages/loopover-ui-kit has no dependency edge to any other package here and is not in the group, +# so it keeps its fully independent release cadence untouched -- which is also why "publish it like +# ui-kit" is the wrong instinct for any future package that something here actually depends on. # # Runs on every push to main, not just a schedule: release-please is idempotent (it recomputes # purely from conventional-commit history since each component's last release tag), so the extra @@ -181,6 +185,12 @@ jobs: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: gh workflow run publish-engine.yml --ref "${{ steps.release.outputs['packages/loopover-engine--tag_name'] }}" -f released_by_release_please=true + - name: Dispatch Contract publish + if: ${{ steps.release.outputs['packages/loopover-contract--release_created'] == 'true' }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh workflow run publish-contract.yml --ref "${{ steps.release.outputs['packages/loopover-contract--tag_name'] }}" -f released_by_release_please=true + - name: Dispatch Miner publish if: ${{ steps.release.outputs['packages/loopover-miner--release_created'] == 'true' }} env: @@ -320,16 +330,24 @@ jobs: return 1 } - engine_ok=true + # packages/loopover-mcp and packages/loopover-miner carry REAL runtime `dependencies` entries on + # BOTH @loopover/engine and @loopover/contract (#9749), so both prerequisites must be live on + # npm before either dependent publishes -- otherwise the dependent resolves a version that + # exists nowhere and fails ETARGET, the same race this whole block exists to avoid. + deps_ok=true + deps_published=false + if needs_publish packages/loopover-contract @loopover/contract; then + if dispatch_and_wait publish-contract.yml; then deps_published=true; else deps_ok=false; fi + fi if needs_publish packages/loopover-engine @loopover/engine; then - dispatch_and_wait publish-engine.yml || engine_ok=false - if [ "$engine_ok" = "true" ]; then - echo "Waiting for npm registry propagation before publishing engine's dependents..." - sleep 30 - fi + if dispatch_and_wait publish-engine.yml; then deps_published=true; else deps_ok=false; fi + fi + if [ "$deps_ok" = "true" ] && [ "$deps_published" = "true" ]; then + echo "Waiting for npm registry propagation before publishing engine/contract dependents..." + sleep 30 fi - if [ "$engine_ok" = "true" ]; then + if [ "$deps_ok" = "true" ]; then if needs_publish packages/loopover-mcp @loopover/mcp; then dispatch_and_wait_with_retry publish-mcp.yml || echo "::warning::publish-mcp.yml did not succeed after retries -- left for manual follow-up." fi @@ -337,7 +355,7 @@ jobs: dispatch_and_wait_with_retry publish-miner.yml || echo "::warning::publish-miner.yml did not succeed after retries -- left for manual follow-up." fi else - echo "::warning::Skipping mcp/miner reconciliation -- publish-engine.yml did not succeed, and they depend on it." + echo "::warning::Skipping mcp/miner reconciliation -- publish-engine.yml and/or publish-contract.yml did not succeed, and they depend on both." fi if needs_publish packages/loopover-ui-kit @loopover/ui-kit; then @@ -353,7 +371,7 @@ jobs: GH_TOKEN: ${{ secrets.RELEASE_PLEASE_TOKEN }} run: | set -euo pipefail - for dir_pkg in "packages/loopover-engine:@loopover/engine" "packages/loopover-mcp:@loopover/mcp" "packages/loopover-miner:@loopover/miner" "packages/loopover-ui-kit:@loopover/ui-kit"; do + for dir_pkg in "packages/loopover-contract:@loopover/contract" "packages/loopover-engine:@loopover/engine" "packages/loopover-mcp:@loopover/mcp" "packages/loopover-miner:@loopover/miner" "packages/loopover-ui-kit:@loopover/ui-kit"; do dir="${dir_pkg%%:*}" pkg="${dir_pkg##*:}" local_version="$(node -p "require('./$dir/package.json').version")" diff --git a/.github/workflows/publish-contract.yml b/.github/workflows/publish-contract.yml new file mode 100644 index 0000000000..9c3154ea5f --- /dev/null +++ b/.github/workflows/publish-contract.yml @@ -0,0 +1,279 @@ +name: Publish Contract Package + +# workflow_dispatch-only, mirroring publish-engine.yml / publish-ui-kit.yml exactly (see publish-mcp.yml +# for the fuller rationale): a GITHUB_TOKEN-created tag doesn't fire push-triggered workflows, so the +# release automation must explicitly dispatch this after tagging. A bare manual dispatch ( +# released_by_release_please left false) is the human override path and self-tags HEAD from +# packages/loopover-contract/package.json's version. +# +# @loopover/contract was bootstrap-published to npm at 0.1.0 from a maintainer's own authenticated +# `npm login` session (#9749) -- npm's trusted publishing/OIDC cannot create a brand-new package -- and +# a Trusted Publisher is configured for it in npmjs.com's package settings against THIS filename +# (GitHub Actions provider, JSONbored/loopover, environment `release`). Renaming this file breaks that +# connection and every publish with it. +# +# ORDERING: packages/loopover-mcp and packages/loopover-miner both carry a REAL runtime `dependencies` +# entry on @loopover/contract, exactly as they do on @loopover/engine. mcp-release-please.yml's +# reconciliation therefore dispatches this workflow alongside engine and BEFORE either dependent, for +# the same ETARGET reason documented at length in that file. +on: + workflow_dispatch: + inputs: + released_by_release_please: + description: "Internal: set by the release automation's dispatch so this run skips re-creating the GitHub release it already made." + type: boolean + default: false + +permissions: + contents: read + +concurrency: + group: publish-contract-${{ github.ref_name }} + cancel-in-progress: false + +jobs: + # Unprivileged: resolves the version, builds, and packs the tarball -- all with contents: read only. + # Same privilege-separation reasoning as publish-engine.yml's validate job. + validate: + runs-on: ubuntu-latest + timeout-minutes: 20 + permissions: + contents: read + outputs: + version: ${{ steps.version.outputs.version }} + tag: ${{ steps.version.outputs.tag }} + release_sha: ${{ steps.version.outputs.release_sha }} + steps: + - name: Checkout + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + with: + fetch-depth: 0 + persist-credentials: false + + - name: Verify release commit is on main + env: + RELEASE_SHA: ${{ github.sha }} + run: | + set -euo pipefail + git fetch --no-tags origin +refs/heads/main:refs/remotes/origin/main + if ! git merge-base --is-ancestor "$RELEASE_SHA" refs/remotes/origin/main; then + echo "::error::Contract package releases must be cut from a commit reachable from main." + exit 1 + fi + + - name: Setup Node + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7 + with: + node-version-file: .nvmrc + + - name: Resolve release version + id: version + run: | + set -euo pipefail + VERSION="$(node -p "require('./packages/loopover-contract/package.json').version")" + if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + echo "::error::Invalid package version: $VERSION" + exit 1 + fi + TAG="contract-v${VERSION}" + # The RELEASE COMMIT is the newest main commit that introduced this exact version string into + # package.json (the release PR's merge commit) -- NOT whatever main head happens to be when + # this run was dispatched. See publish-engine.yml's identical block and #8525 for why. + RELEASE_SHA="$(git log -n 1 --format=%H -S "\"version\": \"${VERSION}\"" refs/remotes/origin/main -- packages/loopover-contract/package.json)" + if [ -z "$RELEASE_SHA" ]; then + echo "::error::Could not resolve the commit that introduced version $VERSION into packages/loopover-contract/package.json -- refusing to guess (would tag main head). (#8525)" + exit 1 + fi + if ! git merge-base --is-ancestor "$RELEASE_SHA" refs/remotes/origin/main; then + echo "::error::Resolved release commit $RELEASE_SHA is not reachable from main." + exit 1 + fi + if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then + TAG_SHA="$(git rev-list -n 1 "$TAG")" + if [ "$TAG_SHA" != "$RELEASE_SHA" ]; then + echo "::error::Tag $TAG already exists but points at $TAG_SHA, not the resolved release commit $RELEASE_SHA" + exit 1 + fi + echo "Tag $TAG already exists and matches the resolved release commit." + else + echo "Tag $TAG does not exist yet; the publish job will create it at $RELEASE_SHA." + fi + # Build/pack against the release commit's own tree, so the published artifact is + # byte-for-byte the content the version number describes. + git checkout --detach "$RELEASE_SHA" + { + echo "version=$VERSION" + echo "tag=$TAG" + echo "release_sha=$RELEASE_SHA" + } >> "$GITHUB_OUTPUT" + + - name: Install dependencies + run: npm ci + + # Build + pack happen in THIS unprivileged job (no id-token). The privileged publish job below + # never runs npm install/build, so a compromised build dependency can't reach the OIDC token. + # There is no separate typecheck step because this package's `build` IS `tsc -p tsconfig.json`. + - name: Pack and smoke-test the tarball + run: | + set -euo pipefail + npm run build --workspace @loopover/contract + PACK_JSON="$(npm pack --workspace @loopover/contract --pack-destination "$RUNNER_TEMP" --json)" + TARBALL="$(node -e 'const fs=require("fs"); const input=fs.readFileSync(0,"utf8"); process.stdout.write(JSON.parse(input)[0].filename)' <<< "$PACK_JSON")" + TARBALL_PATH="$RUNNER_TEMP/$TARBALL" + UNEXPECTED_FILES="$(tar -tzf "$TARBALL_PATH" | grep -Ev '^(package/dist/.+|package/(package.json|README.md|CHANGELOG.md|LICENSE))$' || true)" + if [ -n "$UNEXPECTED_FILES" ]; then + printf '%s\n' "$UNEXPECTED_FILES" + echo "Unexpected file in package tarball" + exit 1 + fi + # Secret scan, with ONE deliberate exclusion. Unlike its sibling packages, this one SHIPS the + # redaction logic: dist/telemetry.js defines SECRET_VALUE_PATTERN, whose source text contains + # a literal `-----BEGIN [A-Z ]*PRIVATE KEY-----` alternative (plus a doc comment quoting a + # full PEM header, describing the bug that alternative fixes). Scanning it with the siblings' + # verbatim pattern is a guaranteed false positive on EVERY release -- verified against the + # 0.1.0 bootstrap tarball. Excluding the module by name keeps the check meaningful for the + # other 92 files rather than weakening the pattern for all of them; if a second module ever + # legitimately needs excluding, that is a signal to reconsider the approach, not to extend + # this list quietly. + SCAN_DIR="$(mktemp -d)" + tar -xzf "$TARBALL_PATH" -C "$SCAN_DIR" + if grep -rqE '(BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY|github_pat_|gh[pousr]_|gts_[0-9a-f]{64}|[A-Z0-9_]*(TOKEN|SECRET|PRIVATE_KEY)=)' \ + "$SCAN_DIR/package" \ + --exclude='telemetry.js' --exclude='telemetry.js.map' --exclude='telemetry.d.ts'; then + echo "Secret-like content found in package tarball" + exit 1 + fi + # And prove the exclusion stayed narrow: the excluded module must still be the ONLY thing that + # would have tripped the scan. If a real secret ever lands in telemetry.js this still fires. + if grep -rqE '(github_pat_|gh[pousr]_[A-Za-z0-9]{16,}|gts_[0-9a-f]{64})' "$SCAN_DIR/package"; then + echo "Real token-shaped content found in package tarball (including the redaction module)" + exit 1 + fi + TMP="$(mktemp -d)" + npm --prefix "$TMP" init -y >/dev/null + npm --prefix "$TMP" install "$TARBALL_PATH" --no-save >/dev/null + node --input-type=module -e " + import { TOOL_CATEGORIES } from '$TMP/node_modules/@loopover/contract/dist/index.js'; + import { PublicStatsSchema } from '$TMP/node_modules/@loopover/contract/dist/public-api.js'; + import { CLI_RESPONSE_SCHEMAS } from '$TMP/node_modules/@loopover/contract/dist/api-schemas.js'; + if (!Array.isArray(TOOL_CATEGORIES) || TOOL_CATEGORIES.length === 0) throw new Error('TOOL_CATEGORIES smoke test failed'); + if (typeof PublicStatsSchema?.parse !== 'function') throw new Error('PublicStatsSchema smoke test failed'); + if (!CLI_RESPONSE_SCHEMAS) throw new Error('CLI_RESPONSE_SCHEMAS smoke test failed'); + " + + - name: Upload package tarball + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + with: + name: loopover-contract-tarball + path: ${{ runner.temp }}/*.tgz + if-no-files-found: error + retention-days: 7 + + # Privileged: tags + publishes the EXACT tarball the unprivileged job already tested. environment: + # release requires reviewer approval per repo Settings > Environments, and is the environment name + # the npmjs.com Trusted Publisher for @loopover/contract is configured against. + publish: + runs-on: ubuntu-latest + needs: validate + environment: release + timeout-minutes: 15 + permissions: + contents: write + id-token: write + steps: + - name: Checkout + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + with: + fetch-depth: 0 + persist-credentials: false + + - name: Verify release commit is on main + env: + RELEASE_SHA: ${{ github.sha }} + run: | + set -euo pipefail + git fetch --no-tags origin +refs/heads/main:refs/remotes/origin/main + if ! git merge-base --is-ancestor "$RELEASE_SHA" refs/remotes/origin/main; then + echo "::error::Contract package releases must be cut from a commit reachable from main." + exit 1 + fi + + - name: Setup Node + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7 + with: + node-version-file: .nvmrc + registry-url: https://registry.npmjs.org + + - name: Create or verify release tag + env: + GH_TOKEN: ${{ github.token }} + TAG: ${{ needs.validate.outputs.tag }} + VERSION: ${{ needs.validate.outputs.version }} + RELEASE_SHA: ${{ needs.validate.outputs.release_sha }} + run: | + set -euo pipefail + if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then + echo "Tag $TAG already exists (verified against the resolved release commit by the validate job)." + else + echo "Creating tag $TAG at the resolved release commit ($RELEASE_SHA) -- never at HEAD (#8525)." + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + git tag -a "$TAG" -m "@loopover/contract v${VERSION}" "$RELEASE_SHA" + git remote set-url origin "https://github.com/${GITHUB_REPOSITORY}.git" + gh auth setup-git + git push origin "$TAG" + fi + + - name: Download package tarball + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: loopover-contract-tarball + path: ${{ runner.temp }}/loopover-contract-package + + - name: Publish to npm (OIDC trusted publishing) + env: + NPM_CONFIG_PROVENANCE: "true" + run: | + set -euo pipefail + count=$(find "$RUNNER_TEMP/loopover-contract-package" -maxdepth 1 -type f -name "*.tgz" | wc -l | tr -d ' ') + if [ "$count" != "1" ]; then + echo "Expected exactly one tarball, found $count" >&2 + find "$RUNNER_TEMP/loopover-contract-package" -maxdepth 1 -type f -name "*.tgz" -print >&2 + exit 1 + fi + tarball=$(find "$RUNNER_TEMP/loopover-contract-package" -maxdepth 1 -type f -name "*.tgz" -print -quit) + npx -y npm@11.15.0 publish "$tarball" --access public --provenance + + github-release: + runs-on: ubuntu-latest + needs: [validate, publish] + # Skip when the release automation dispatched this run: it already created the GitHub release with + # its own generated changelog notes before dispatching, so running this unconditionally would + # overwrite those richer notes with the generic blurb below. + if: ${{ inputs.released_by_release_please != true }} + timeout-minutes: 5 + permissions: + contents: write + steps: + - name: Create GitHub release + env: + GH_TOKEN: ${{ github.token }} + RELEASE_TAG: ${{ needs.validate.outputs.tag }} + RELEASE_VERSION: ${{ needs.validate.outputs.version }} + run: | + set -euo pipefail + NOTES_FILE="$(mktemp)" + cat > "$NOTES_FILE" </dev/null 2>&1; then + gh release edit "$RELEASE_TAG" --repo "$GITHUB_REPOSITORY" --title "@loopover/contract v${RELEASE_VERSION}" --notes-file "$NOTES_FILE" + else + gh release create "$RELEASE_TAG" --repo "$GITHUB_REPOSITORY" --title "@loopover/contract v${RELEASE_VERSION}" --notes-file "$NOTES_FILE" --verify-tag + fi diff --git a/.release-please-manifest.json b/.release-please-manifest.json index dd24bcc4d2..6cac966883 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -2,5 +2,6 @@ "packages/loopover-mcp": "3.15.2", "packages/loopover-engine": "3.16.1", "packages/loopover-miner": "3.15.2", - "packages/loopover-ui-kit": "1.2.0" + "packages/loopover-ui-kit": "1.2.0", + "packages/loopover-contract": "0.1.0" } diff --git a/package.json b/package.json index b77c15b808..49b104d3d4 100644 --- a/package.json +++ b/package.json @@ -91,6 +91,7 @@ "engines-nvmrc:check": "node --experimental-strip-types scripts/check-engines-nvmrc-sync.ts", "release-manifest:sync": "node --experimental-strip-types scripts/sync-release-manifest.ts", "release-manifest:sync:check": "node --experimental-strip-types scripts/sync-release-manifest.ts --check", + "release-linked-versions:check": "node --experimental-strip-types scripts/check-release-linked-versions.ts", "ui:deploy": "npm run ui:build && npm run ui:deploy:built", "ui:deploy:built": "wrangler deploy --config apps/loopover-ui/dist/server/wrangler.json", "ui:version:built": "wrangler versions upload --config apps/loopover-ui/dist/server/wrangler.json", @@ -126,7 +127,7 @@ "test:smoke:browser:install": "playwright install chromium", "test:smoke:browser": "node --experimental-strip-types scripts/smoke-ui-browser.ts", "pretest:ci": "npm run check-node-version", - "test:ci": "git diff --check && npm run actionlint && npm run lint:composite-actions && npm run db:migrations:check && npm run db:schema-drift:check && npm run selfhost:env-reference:check && npm run miner:env-reference:check && npm run selfhost:validate-observability && npm run cf-typegen:check && npm run build --workspace @loopover/engine && npm run build --workspace @loopover/discovery-index && npm run build:mcp && npm run build:miner && npm run build --workspace @loopover/ui-kit && npm run typecheck && npm run test:coverage && npm run test:engine-parity && npm run test:live-gate-parity && npm run test:driver-parity && npm run validate:mcp && npm run test --workspace @loopover/engine && npm run test:workers && npm run test:mcp-pack && npm run test:miner-pack && npm run test:engine-pack && npm run test:ui-kit-pack && npm run test:miner-deployment-docs-audit && npm run rees:test && npm run ui:openapi:check && npm run ui:version-audit && npm run docs:drift-check && npm run coverage-boltons:check && npm run import-specifiers:check && npm run ui-derived-types:check && npm run dead-source-files:check && npm run regate-sort-key:check && npm run command-redelivery-guards:check && npm run dispatch-gate-reasons:check && npm run validate:no-hand-written-js && npm run replay-runner-manifest:check && npm run coco-dev-versions:check && npm run branding-drift:check && npm run manifest:drift-check && npm run engine-parity:drift-check && npm run engines-nvmrc:check && npm run release-manifest:sync:check && npm run command-reference:check && npm run mcp:tool-reference:check && npm run contract:api-schemas:check && npm run ui:lint && npm run ui:typecheck && npm run ui:test && npm run ui:build", + "test:ci": "git diff --check && npm run actionlint && npm run lint:composite-actions && npm run db:migrations:check && npm run db:schema-drift:check && npm run selfhost:env-reference:check && npm run miner:env-reference:check && npm run selfhost:validate-observability && npm run cf-typegen:check && npm run build --workspace @loopover/engine && npm run build --workspace @loopover/discovery-index && npm run build:mcp && npm run build:miner && npm run build --workspace @loopover/ui-kit && npm run typecheck && npm run test:coverage && npm run test:engine-parity && npm run test:live-gate-parity && npm run test:driver-parity && npm run validate:mcp && npm run test --workspace @loopover/engine && npm run test:workers && npm run test:mcp-pack && npm run test:miner-pack && npm run test:engine-pack && npm run test:ui-kit-pack && npm run test:miner-deployment-docs-audit && npm run rees:test && npm run ui:openapi:check && npm run ui:version-audit && npm run docs:drift-check && npm run coverage-boltons:check && npm run import-specifiers:check && npm run ui-derived-types:check && npm run dead-source-files:check && npm run regate-sort-key:check && npm run command-redelivery-guards:check && npm run dispatch-gate-reasons:check && npm run validate:no-hand-written-js && npm run replay-runner-manifest:check && npm run coco-dev-versions:check && npm run branding-drift:check && npm run manifest:drift-check && npm run engine-parity:drift-check && npm run engines-nvmrc:check && npm run release-manifest:sync:check && npm run release-linked-versions:check && npm run command-reference:check && npm run mcp:tool-reference:check && npm run contract:api-schemas:check && npm run ui:lint && npm run ui:typecheck && npm run ui:test && npm run ui:build", "test:release": "npm run test:ci && npm run changelog:check", "test:release:mcp": "npm run test:ci", "test:watch": "vitest", diff --git a/packages/loopover-contract/LICENSE b/packages/loopover-contract/LICENSE new file mode 100644 index 0000000000..be3f7b28e5 --- /dev/null +++ b/packages/loopover-contract/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/release-please-config.json b/release-please-config.json index 1c4b4d1b91..ab11e0a539 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -20,6 +20,11 @@ "release-type": "node", "component": "ui-kit", "package-name": "@loopover/ui-kit" + }, + "packages/loopover-contract": { + "release-type": "node", + "component": "contract", + "package-name": "@loopover/contract" } }, "include-component-in-tag": true, @@ -34,7 +39,7 @@ { "type": "linked-versions", "groupName": "engine-and-dependents", - "components": ["engine", "mcp", "miner"], + "components": ["engine", "contract", "mcp", "miner"], "merge": true } ], diff --git a/scripts/check-release-linked-versions.ts b/scripts/check-release-linked-versions.ts new file mode 100644 index 0000000000..39e362ecf5 --- /dev/null +++ b/scripts/check-release-linked-versions.ts @@ -0,0 +1,170 @@ +#!/usr/bin/env node +// Enforces the two release-config invariants that are otherwise only remembered, both of which have +// already been broken silently in this repo. +// +// (1) LINKED-VERSIONS COVERAGE. mcp-release-please.yml's header explains the failure at length: when +// one release-please component carries a real dependency on another, node-workspace bumps the +// dependent's version range the moment the prerequisite's version changes -- but under +// separate-pull-requests: true that bump lands on the dependent's OWN branch, so its package.json +// requires a version that exists nowhere (not locally, since the prerequisite's bump is on a +// different unmerged branch; not on npm, since it hasn't published). `npm ci` then fails ETARGET. +// Confirmed live across several mcp/miner cycles (#7086/#7087/#7107/#7108/#7119/#7120/#7121). +// node-workspace's own `merge` option does NOT override separate-pull-requests; the linked-versions +// plugin is the only mechanism that does, and only for the components named in its group. +// +// That makes group membership a function of the DEPENDENCY GRAPH, not of release cadence -- and +// nothing enforced it. #9521 introduced @loopover/contract as a runtime dependency of both +// @loopover/mcp and @loopover/miner without adding it to the group, and that went unnoticed until +// #9749; the package was not even published, so the next mcp/miner release would have shipped +// uninstallable. This check derives the required grouping from the real package.json edges so the +// next such edge fails CI instead of a release. +// +// (2) MANIFEST COVERAGE. sync-release-manifest.ts derives its work list from +// .release-please-manifest.json's OWN keys and skips any workspace it doesn't already track +// (`if (!(workspacePath in manifest)) continue`). A package added to release-please-config.json but +// not to the manifest is therefore silently exempt from the staleness check that exists to stop +// release-please re-proposing an already-published version. Adding a package to one file and not +// the other is a one-line mistake with no feedback, so it is checked here. +// +// PURE core + thin IO, mirroring sync-release-manifest.ts's own split so the logic is unit-testable +// without touching the filesystem. +import { readFileSync } from "node:fs"; +import { pathToFileURL } from "node:url"; + +export const CONFIG_PATH = "release-please-config.json"; +export const MANIFEST_PATH = ".release-please-manifest.json"; + +/** Dependency fields that SHIP to a consumer and so can break an install of the published package, + * not just a workspace `npm ci`. `devDependencies` is deliberately excluded: it never reaches a + * consumer, and forcing two packages into permanent version lockstep over a build-time-only edge + * costs more than the failure it would prevent (which surfaces immediately in CI on the branch that + * introduced it, rather than in a published artifact). If a devDependency edge ever does cause a + * release failure, this comment is the record of the tradeoff that allowed it. */ +export const SHIP_AFFECTING_DEPENDENCY_FIELDS = ["dependencies", "peerDependencies", "optionalDependencies"] as const; + +export type ReleaseConfig = { + packages: Record; + plugins?: unknown[]; +}; + +export type PackageManifest = { + name?: string; + dependencies?: Record; + devDependencies?: Record; + peerDependencies?: Record; + optionalDependencies?: Record; +}; + +export type LinkedVersionsViolation = + | { kind: "missing_manifest_entry"; workspacePath: string } + | { kind: "unlinked_dependency_edge"; fromPackage: string; toPackage: string; field: string; fromGroup: string | null; toGroup: string | null }; + +/** Component -> linked-versions group name, for every component named in any linked-versions plugin. */ +export function linkedVersionGroups(config: ReleaseConfig): Map { + const groups = new Map(); + for (const plugin of config.plugins ?? []) { + if (typeof plugin !== "object" || plugin === null) continue; + const entry = plugin as { type?: unknown; groupName?: unknown; components?: unknown }; + if (entry.type !== "linked-versions" || !Array.isArray(entry.components)) continue; + const groupName = typeof entry.groupName === "string" ? entry.groupName : ""; + for (const component of entry.components) { + if (typeof component === "string") groups.set(component, groupName); + } + } + return groups; +} + +/** + * PURE. Returns every violation of the two invariants above. `packageJsons` is keyed by the same + * workspace paths release-please-config.json uses. + */ +export function checkReleaseLinkedVersions(input: { + config: ReleaseConfig; + manifestKeys: readonly string[]; + packageJsons: Record; +}): LinkedVersionsViolation[] { + const { config, manifestKeys, packageJsons } = input; + const violations: LinkedVersionsViolation[] = []; + const trackedPaths = Object.keys(config.packages ?? {}); + const manifestSet = new Set(manifestKeys); + + for (const workspacePath of trackedPaths) { + if (!manifestSet.has(workspacePath)) violations.push({ kind: "missing_manifest_entry", workspacePath }); + } + + const groups = linkedVersionGroups(config); + // Published package name -> its release-please component, for tracked packages only. An edge to a + // package release-please does not track cannot race a release, so it is not this check's business. + const componentByPackageName = new Map(); + for (const workspacePath of trackedPaths) { + const name = packageJsons[workspacePath]?.name; + const component = config.packages[workspacePath]?.component; + if (typeof name === "string" && typeof component === "string") componentByPackageName.set(name, component); + } + + for (const workspacePath of trackedPaths) { + const pkg = packageJsons[workspacePath]; + const fromName = pkg?.name; + const fromComponent = config.packages[workspacePath]?.component; + if (!pkg || typeof fromName !== "string" || typeof fromComponent !== "string") continue; + for (const field of SHIP_AFFECTING_DEPENDENCY_FIELDS) { + for (const depName of Object.keys(pkg[field] ?? {})) { + const toComponent = componentByPackageName.get(depName); + if (toComponent === undefined) continue; // not a release-please-tracked package + const fromGroup = groups.get(fromComponent) ?? null; + const toGroup = groups.get(toComponent) ?? null; + if (fromGroup === null || toGroup === null || fromGroup !== toGroup) { + violations.push({ kind: "unlinked_dependency_edge", fromPackage: fromName, toPackage: depName, field, fromGroup, toGroup }); + } + } + } + } + + return violations; +} + +export type CheckIo = { + readFileSync: (path: string, encoding: string) => string; + log: (...args: unknown[]) => void; + error: (...args: unknown[]) => void; + exit: (code: number) => void; +}; + +export function main( + io: CheckIo = { + readFileSync: (path: string, encoding: string) => readFileSync(path, encoding as BufferEncoding), + log: console.log.bind(console), + error: console.error.bind(console), + exit: (code: number) => process.exit(code), + }, +): number { + const config = JSON.parse(io.readFileSync(CONFIG_PATH, "utf8")) as ReleaseConfig; + const manifestKeys = Object.keys(JSON.parse(io.readFileSync(MANIFEST_PATH, "utf8"))); + const trackedPaths = Object.keys(config.packages ?? {}); + const packageJsons = Object.fromEntries( + trackedPaths.map((workspacePath) => [workspacePath, JSON.parse(io.readFileSync(`${workspacePath}/package.json`, "utf8")) as PackageManifest]), + ); + + const violations = checkReleaseLinkedVersions({ config, manifestKeys, packageJsons }); + for (const violation of violations) { + if (violation.kind === "missing_manifest_entry") { + io.error(`${MANIFEST_PATH}: missing an entry for ${violation.workspacePath}, which ${CONFIG_PATH} tracks.`); + io.error(` sync-release-manifest.ts skips workspaces the manifest doesn't already list, so this package is silently exempt from its staleness check.`); + } else { + io.error(`${CONFIG_PATH}: ${violation.fromPackage} depends on ${violation.toPackage} (${violation.field}), but they are not in the same linked-versions group.`); + io.error(` ${violation.fromPackage} group: ${violation.fromGroup ?? ""} | ${violation.toPackage} group: ${violation.toGroup ?? ""}`); + } + } + if (violations.length > 0) { + io.error( + `check-release-linked-versions: ${violations.length} violation(s). A dependency edge between release-please components MUST sit inside one linked-versions group, or the dependent's release PR will require a version that exists nowhere and fail ETARGET on npm ci (see mcp-release-please.yml's header).`, + ); + io.exit(1); + return 1; + } + io.log(`check-release-linked-versions: ${trackedPaths.length} tracked package(s), all dependency edges linked and manifest-tracked.`); + return 0; +} + +const invokedDirectly = process.argv[1] != null && import.meta.url === pathToFileURL(process.argv[1]).href; +if (invokedDirectly) main(); diff --git a/test/unit/check-release-linked-versions.test.ts b/test/unit/check-release-linked-versions.test.ts new file mode 100644 index 0000000000..a750aa17e9 --- /dev/null +++ b/test/unit/check-release-linked-versions.test.ts @@ -0,0 +1,156 @@ +import { describe, expect, it, vi } from "vitest"; +import { + checkReleaseLinkedVersions, + CONFIG_PATH, + linkedVersionGroups, + main, + MANIFEST_PATH, + SHIP_AFFECTING_DEPENDENCY_FIELDS, + type PackageManifest, + type ReleaseConfig, +} from "../../scripts/check-release-linked-versions"; + +// #9749: group membership is a function of the DEPENDENCY GRAPH, not release cadence. These cases pin +// the two failures that actually happened -- contract added as a runtime dependency without joining the +// group, and a package tracked in the config but absent from the manifest. + +const CONFIG: ReleaseConfig = { + packages: { + "packages/loopover-engine": { component: "engine", "package-name": "@loopover/engine" }, + "packages/loopover-contract": { component: "contract", "package-name": "@loopover/contract" }, + "packages/loopover-mcp": { component: "mcp", "package-name": "@loopover/mcp" }, + "packages/loopover-ui-kit": { component: "ui-kit", "package-name": "@loopover/ui-kit" }, + }, + plugins: [{ type: "node-workspace", merge: false }, { type: "linked-versions", groupName: "engine-and-dependents", components: ["engine", "contract", "mcp"] }], +}; + +const PACKAGES: Record = { + "packages/loopover-engine": { name: "@loopover/engine" }, + "packages/loopover-contract": { name: "@loopover/contract" }, + "packages/loopover-mcp": { name: "@loopover/mcp", dependencies: { "@loopover/engine": "^3.16.0", "@loopover/contract": "^0.1.0", zod: "^4.4.3" } }, + "packages/loopover-ui-kit": { name: "@loopover/ui-kit" }, +}; + +const MANIFEST_KEYS = Object.keys(CONFIG.packages); + +describe("linkedVersionGroups", () => { + it("maps every named component to its group and ignores non-linked-versions plugins", () => { + const groups = linkedVersionGroups(CONFIG); + expect(groups.get("engine")).toBe("engine-and-dependents"); + expect(groups.get("contract")).toBe("engine-and-dependents"); + expect(groups.get("ui-kit")).toBeUndefined(); + }); + + it("tolerates a malformed plugin list rather than throwing on a config typo", () => { + expect(linkedVersionGroups({ packages: {}, plugins: [null, "nope", { type: "linked-versions" }, { type: "linked-versions", components: [42, "ok"] }] as unknown[] }).get("ok")).toBe(""); + expect(linkedVersionGroups({ packages: {} }).size).toBe(0); + }); +}); + +describe("checkReleaseLinkedVersions (#9749)", () => { + it("passes when every dependency edge sits inside one group and every package is manifest-tracked", () => { + expect(checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons: PACKAGES })).toEqual([]); + }); + + it("REGRESSION: catches a dependency on a component left out of the group -- the #9521 gap", () => { + const config: ReleaseConfig = { ...CONFIG, plugins: [{ type: "linked-versions", groupName: "engine-and-dependents", components: ["engine", "mcp"] }] }; + expect(checkReleaseLinkedVersions({ config, manifestKeys: MANIFEST_KEYS, packageJsons: PACKAGES })).toEqual([ + { kind: "unlinked_dependency_edge", fromPackage: "@loopover/mcp", toPackage: "@loopover/contract", field: "dependencies", fromGroup: "engine-and-dependents", toGroup: null }, + ]); + }); + + it("catches two components that are grouped, but into DIFFERENT groups", () => { + const config: ReleaseConfig = { + ...CONFIG, + plugins: [ + { type: "linked-versions", groupName: "a", components: ["mcp"] }, + { type: "linked-versions", groupName: "b", components: ["engine", "contract"] }, + ], + }; + const violations = checkReleaseLinkedVersions({ config, manifestKeys: MANIFEST_KEYS, packageJsons: PACKAGES }); + expect(violations).toHaveLength(2); + expect(violations.every((v) => v.kind === "unlinked_dependency_edge" && v.fromGroup === "a" && v.toGroup === "b")).toBe(true); + }); + + it("REGRESSION: catches a config-tracked package with no manifest entry, which sync-release-manifest silently skips", () => { + const violations = checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS.filter((k) => k !== "packages/loopover-contract"), packageJsons: PACKAGES }); + expect(violations).toEqual([{ kind: "missing_manifest_entry", workspacePath: "packages/loopover-contract" }]); + }); + + it("INVARIANT: a package with no dependency edge stays ungrouped without complaint (ui-kit's whole point)", () => { + // ui-kit is deliberately outside the group; that must never be reported, or the check would push + // unrelated packages into permanent version lockstep. + const violations = checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons: PACKAGES }); + expect(violations.some((v) => JSON.stringify(v).includes("ui-kit"))).toBe(false); + }); + + it("ignores edges to packages release-please does not track -- they cannot race a release", () => { + const packageJsons = { ...PACKAGES, "packages/loopover-mcp": { name: "@loopover/mcp", dependencies: { zod: "^4.4.3", "@modelcontextprotocol/sdk": "1.29.0" } } }; + expect(checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons })).toEqual([]); + }); + + it("checks every shipping dependency field, not just `dependencies`", () => { + for (const field of SHIP_AFFECTING_DEPENDENCY_FIELDS) { + const packageJsons = { ...PACKAGES, "packages/loopover-ui-kit": { name: "@loopover/ui-kit", [field]: { "@loopover/engine": "^3.16.0" } } }; + const violations = checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons }); + expect(violations).toEqual([{ kind: "unlinked_dependency_edge", fromPackage: "@loopover/ui-kit", toPackage: "@loopover/engine", field, fromGroup: null, toGroup: "engine-and-dependents" }]); + } + }); + + it("does NOT flag a devDependency edge -- deliberately excluded, since it never reaches a consumer", () => { + const packageJsons = { ...PACKAGES, "packages/loopover-ui-kit": { name: "@loopover/ui-kit", devDependencies: { "@loopover/engine": "^3.16.0" } } }; + expect(checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons })).toEqual([]); + }); + + it("skips a tracked workspace whose package.json is unreadable rather than crashing the whole check", () => { + const packageJsons = { ...PACKAGES, "packages/loopover-mcp": { dependencies: { "@loopover/contract": "^0.1.0" } } }; // no `name` + expect(checkReleaseLinkedVersions({ config: CONFIG, manifestKeys: MANIFEST_KEYS, packageJsons })).toEqual([]); + }); + + it("tolerates an empty config", () => { + expect(checkReleaseLinkedVersions({ config: { packages: {} }, manifestKeys: [], packageJsons: {} })).toEqual([]); + }); +}); + +describe("check-release-linked-versions main()", () => { + const io = (files: Record) => { + const log = vi.fn(); + const error = vi.fn(); + const exit = vi.fn(); + return { + io: { readFileSync: (path: string) => JSON.stringify(files[path]), log, error, exit }, + log, + error, + exit, + }; + }; + + const FILES = { + [CONFIG_PATH]: CONFIG, + [MANIFEST_PATH]: Object.fromEntries(MANIFEST_KEYS.map((k) => [k, "1.0.0"])), + ...Object.fromEntries(Object.entries(PACKAGES).map(([path, pkg]) => [`${path}/package.json`, pkg])), + }; + + it("exits 0 and reports the tracked count when the config is coherent", () => { + const { io: stub, log, exit } = io(FILES); + expect(main(stub)).toBe(0); + expect(exit).not.toHaveBeenCalled(); + expect(String(log.mock.calls[0]?.[0])).toContain("4 tracked package(s)"); + }); + + it("exits 1 and names the offending edge when a dependency escapes the group", () => { + const broken = { ...FILES, [CONFIG_PATH]: { ...CONFIG, plugins: [{ type: "linked-versions", groupName: "g", components: ["engine", "mcp"] }] } }; + const { io: stub, error, exit } = io(broken); + expect(main(stub)).toBe(1); + expect(exit).toHaveBeenCalledWith(1); + expect(error.mock.calls.flat().join(" ")).toContain("@loopover/mcp depends on @loopover/contract"); + }); + + it("exits 1 and explains the consequence when the manifest entry is missing", () => { + const broken = { ...FILES, [MANIFEST_PATH]: { "packages/loopover-engine": "1.0.0" } }; + const { io: stub, error, exit } = io(broken); + expect(main(stub)).toBe(1); + expect(exit).toHaveBeenCalledWith(1); + expect(error.mock.calls.flat().join(" ")).toContain("silently exempt"); + }); +});