Compare commits
9
Commits
fefe34be03
..
v0.1.3
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e83cdc62a7 | ||
|
|
fa2a1493ea | ||
|
|
88038476b3 | ||
|
|
871d198221 | ||
|
|
c28e4b2de7 | ||
|
|
6233de0e5c | ||
|
|
6fca109375 | ||
|
|
e7f7404d35 | ||
|
|
33bb146349 |
+60
-83
@@ -1,8 +1,10 @@
|
|||||||
name: CI
|
name: CI
|
||||||
|
|
||||||
# Signage builds, tests, and runs only inside an Ekklesia workspace, so every job first assembles it
|
# Signage is a standalone repository: every job installs it with --frozen-lockfile from its own
|
||||||
# into the platform commit pinned in ci/platform.env (ci/assemble.sh) and installs that workspace
|
# pnpm-lock.yaml and takes Ekklesia's module-development packages (@ekklesia/*) from Ekklesia's
|
||||||
# with --frozen-lockfile from ci/pnpm-lock.yaml.
|
# public package registry (.npmrc; platform ADRs 0053 and 0054). Only the integration job fetches
|
||||||
|
# Core source: one immutable commit through the pinned Gitea pull ref in ci/platform.env, used as the
|
||||||
|
# generic deployment harness and image source, never as a workspace dependency.
|
||||||
#
|
#
|
||||||
# The same trust rules as the platform's own CI (docs/development/security.md there):
|
# The same trust rules as the platform's own CI (docs/development/security.md there):
|
||||||
# * every action is pinned by a full commit SHA;
|
# * every action is pinned by a full commit SHA;
|
||||||
@@ -11,10 +13,8 @@ name: CI
|
|||||||
# * there is no `pull_request_target`;
|
# * there is no `pull_request_target`;
|
||||||
# * the self-hosted runner executes trusted, reviewed code only.
|
# * the self-hosted runner executes trusted, reviewed code only.
|
||||||
#
|
#
|
||||||
# The server is Gitea 1.24, which ignores `permissions`, `concurrency`, and `timeout-minutes`
|
# The server is Gitea 1.27, which honours `concurrency` cancellation; `permissions` and
|
||||||
# (https://docs.gitea.com/1.24/usage/actions/comparison). They are declared so the workflow is already
|
# `timeout-minutes` are declared so the workflow is correct wherever they are enforced.
|
||||||
# correct on a release that honours them; on 1.24 they bound nothing, and `permissions` does not
|
|
||||||
# restrict the job token.
|
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
@@ -42,24 +42,21 @@ jobs:
|
|||||||
# in .git/config for a later step to read.
|
# in .git/config for a later step to read.
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Assemble Signage into the pinned platform
|
- name: Set up Node.js at the repository's version
|
||||||
run: bash ci/assemble.sh
|
|
||||||
|
|
||||||
- name: Set up Node.js at the platform's version
|
|
||||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
with:
|
with:
|
||||||
node-version-file: build/workspace/.node-version
|
node-version-file: .node-version
|
||||||
|
|
||||||
- name: Install the assembled workspace (frozen lockfile)
|
# pnpm at exactly the `packageManager` version, and @ekklesia/* from the public registry named in
|
||||||
working-directory: build/workspace
|
# .npmrc: no token, and no Ekklesia checkout.
|
||||||
|
- name: Install (frozen lockfile)
|
||||||
run: |
|
run: |
|
||||||
corepack enable
|
corepack enable
|
||||||
corepack install
|
corepack install
|
||||||
pnpm install --frozen-lockfile
|
pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
working-directory: build/workspace
|
run: pnpm lint
|
||||||
run: pnpm --filter @ekklesia/signage lint
|
|
||||||
|
|
||||||
- name: Check that CI cleans up every stack it starts
|
- name: Check that CI cleans up every stack it starts
|
||||||
run: bash ci/check-cleanup.sh
|
run: bash ci/check-cleanup.sh
|
||||||
@@ -76,28 +73,21 @@ jobs:
|
|||||||
# in .git/config for a later step to read.
|
# in .git/config for a later step to read.
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Assemble Signage into the pinned platform
|
- name: Set up Node.js at the repository's version
|
||||||
run: bash ci/assemble.sh
|
|
||||||
|
|
||||||
- name: Set up Node.js at the platform's version
|
|
||||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
with:
|
with:
|
||||||
node-version-file: build/workspace/.node-version
|
node-version-file: .node-version
|
||||||
|
|
||||||
- name: Install the assembled workspace (frozen lockfile)
|
# pnpm at exactly the `packageManager` version, and @ekklesia/* from the public registry named in
|
||||||
working-directory: build/workspace
|
# .npmrc: no token, and no Ekklesia checkout.
|
||||||
|
- name: Install (frozen lockfile)
|
||||||
run: |
|
run: |
|
||||||
corepack enable
|
corepack enable
|
||||||
corepack install
|
corepack install
|
||||||
pnpm install --frozen-lockfile
|
pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Build the platform packages Signage depends on
|
|
||||||
working-directory: build/workspace
|
|
||||||
run: pnpm exec turbo run build --filter='@ekklesia/signage^...'
|
|
||||||
|
|
||||||
- name: Typecheck the server, browser, and browser-test projects
|
- name: Typecheck the server, browser, and browser-test projects
|
||||||
working-directory: build/workspace
|
run: pnpm typecheck
|
||||||
run: pnpm --filter @ekklesia/signage typecheck
|
|
||||||
|
|
||||||
test:
|
test:
|
||||||
name: test
|
name: test
|
||||||
@@ -111,28 +101,21 @@ jobs:
|
|||||||
# in .git/config for a later step to read.
|
# in .git/config for a later step to read.
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Assemble Signage into the pinned platform
|
- name: Set up Node.js at the repository's version
|
||||||
run: bash ci/assemble.sh
|
|
||||||
|
|
||||||
- name: Set up Node.js at the platform's version
|
|
||||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
with:
|
with:
|
||||||
node-version-file: build/workspace/.node-version
|
node-version-file: .node-version
|
||||||
|
|
||||||
- name: Install the assembled workspace (frozen lockfile)
|
# pnpm at exactly the `packageManager` version, and @ekklesia/* from the public registry named in
|
||||||
working-directory: build/workspace
|
# .npmrc: no token, and no Ekklesia checkout.
|
||||||
|
- name: Install (frozen lockfile)
|
||||||
run: |
|
run: |
|
||||||
corepack enable
|
corepack enable
|
||||||
corepack install
|
corepack install
|
||||||
pnpm install --frozen-lockfile
|
pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Build the platform packages Signage depends on
|
|
||||||
working-directory: build/workspace
|
|
||||||
run: pnpm exec turbo run build --filter='@ekklesia/signage^...'
|
|
||||||
|
|
||||||
- name: Unit, browser, and display contract tests
|
- name: Unit, browser, and display contract tests
|
||||||
working-directory: build/workspace
|
run: pnpm test
|
||||||
run: pnpm --filter @ekklesia/signage test
|
|
||||||
|
|
||||||
build:
|
build:
|
||||||
name: build
|
name: build
|
||||||
@@ -146,51 +129,34 @@ jobs:
|
|||||||
# in .git/config for a later step to read.
|
# in .git/config for a later step to read.
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Assemble Signage into the pinned platform
|
- name: Set up Node.js at the repository's version
|
||||||
run: bash ci/assemble.sh
|
|
||||||
|
|
||||||
- name: Set up Node.js at the platform's version
|
|
||||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
with:
|
with:
|
||||||
node-version-file: build/workspace/.node-version
|
node-version-file: .node-version
|
||||||
|
|
||||||
- name: Install the assembled workspace (frozen lockfile)
|
# pnpm at exactly the `packageManager` version, and @ekklesia/* from the public registry named in
|
||||||
working-directory: build/workspace
|
# .npmrc: no token, and no Ekklesia checkout.
|
||||||
|
- name: Install (frozen lockfile)
|
||||||
run: |
|
run: |
|
||||||
corepack enable
|
corepack enable
|
||||||
corepack install
|
corepack install
|
||||||
pnpm install --frozen-lockfile
|
pnpm install --frozen-lockfile
|
||||||
|
|
||||||
# The same gates the platform's image build runs against exactly this module set: its boundary
|
- name: Build the server and both browser artifacts
|
||||||
# rules (which apply to modules), the manifest, and the migrations.
|
run: pnpm build
|
||||||
- name: Platform gates (boundaries, module manifest, migrations)
|
|
||||||
working-directory: build/workspace
|
|
||||||
run: |
|
|
||||||
pnpm boundaries
|
|
||||||
pnpm modules:validate
|
|
||||||
pnpm migrations:validate
|
|
||||||
|
|
||||||
- name: Build Signage and the platform it depends on
|
# The built package and its migrations, read the way the platform reads them, with only the
|
||||||
working-directory: build/workspace
|
# published SDK parsers (scripts/validate-module.mjs says what only Ekklesia itself can check).
|
||||||
run: pnpm exec turbo run build --filter='@ekklesia/signage...'
|
- name: Validate the built module and its migrations
|
||||||
|
run: pnpm validate
|
||||||
|
|
||||||
# Signage inside Ekklesia, end to end, in a real browser: the platform's own Dockerfile builds the
|
# The real linux-x64-glibc Signage Module Package inside Ekklesia, end to end. The pinned platform
|
||||||
# deployment image with Signage in it, and the platform's split-topology deployment smoke runs
|
# builds one generic image with no bundled module source, verifies and installs Signage into
|
||||||
# against it, pairing a kiosk display and running the scenarios in ci/display-scenarios. A
|
# persistent module storage, applies its migrations, and drives its split-origin Dashboard and
|
||||||
# disposable database and object store with generated secrets; nothing is pushed or logged in to.
|
# kiosk display in real browsers. It then checks process restart, container recreation, lifecycle
|
||||||
#
|
# disable/re-enable, removal, and reinstall against the same database and package.
|
||||||
# DISABLED while Signage is pinned to Ekklesia 0.2.0. From that release on, the platform's image is
|
|
||||||
# the one generic image (platform ADR 0048): deploy/Dockerfile keeps `modules/` out of its build
|
|
||||||
# context and refuses one that has it, and the deployment smoke installs modules only as canonical
|
|
||||||
# Module Packages (ADR 0049). Signage is not one yet: its static sharp dependency needs the native
|
|
||||||
# linux-x64-glibc package flow, which is deliberately not part of the 0.2.0 compatibility change.
|
|
||||||
# Run against 0.2.0, this job would build an image without Signage and drive the module template's
|
|
||||||
# display instead, so it is switched off rather than left reporting on something else. The job and
|
|
||||||
# ci/integration.sh stay as they are; the job returns once Signage is built as a Module Package and
|
|
||||||
# installed into the generic image, and `if: false` is removed in that change.
|
|
||||||
integration:
|
integration:
|
||||||
name: integration
|
name: integration
|
||||||
if: false
|
|
||||||
needs:
|
needs:
|
||||||
- test
|
- test
|
||||||
- build
|
- build
|
||||||
@@ -207,22 +173,33 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: Assemble Signage into the pinned platform
|
- name: Set up Node.js at the repository's version
|
||||||
run: bash ci/assemble.sh
|
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
|
||||||
|
- name: Install (frozen lockfile)
|
||||||
|
run: |
|
||||||
|
corepack enable
|
||||||
|
corepack install
|
||||||
|
pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Fetch the pinned Ekklesia integration harness
|
||||||
|
run: bash ci/fetch-platform.sh
|
||||||
|
|
||||||
# A job the runner killed (cancelled, or past the runner's own time limit) never ran its
|
# A job the runner killed (cancelled, or past the runner's own time limit) never ran its
|
||||||
# cleanup. Anything a CI job left on this shared daemon more than three hours ago goes first.
|
# cleanup. Anything a CI job left on this shared daemon more than three hours ago goes first.
|
||||||
- name: Sweep stale CI stacks from the runner
|
- name: Sweep stale CI stacks from the runner
|
||||||
run: bash build/workspace/scripts/ci-sweep.sh --stale
|
run: bash build/platform/scripts/ci-sweep.sh --stale
|
||||||
|
|
||||||
- name: Build the image and run the display scenarios
|
- name: Build, install, and run the external Signage package
|
||||||
run: bash ci/integration.sh
|
run: bash ci/integration.sh
|
||||||
|
|
||||||
# Whatever happened above, this job's own stacks do not outlive it. If assembly failed, nothing
|
# Whatever happened above, this job's own stacks do not outlive it. If the first step failed,
|
||||||
# was started.
|
# nothing was started.
|
||||||
- name: Remove this job's CI stacks
|
- name: Remove this job's CI stacks
|
||||||
if: always()
|
if: always()
|
||||||
run: |
|
run: |
|
||||||
if [ -f build/workspace/scripts/ci-sweep.sh ]; then
|
if [ -f build/platform/scripts/ci-sweep.sh ]; then
|
||||||
bash build/workspace/scripts/ci-sweep.sh --job
|
bash build/platform/scripts/ci-sweep.sh --job
|
||||||
fi
|
fi
|
||||||
|
|||||||
+2
-1
@@ -1,7 +1,8 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
.pnpm-store/
|
||||||
dist/
|
dist/
|
||||||
.turbo/
|
.turbo/
|
||||||
coverage/
|
coverage/
|
||||||
|
build/
|
||||||
*.log
|
*.log
|
||||||
.DS_Store
|
.DS_Store
|
||||||
build/
|
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
24.18.0
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Ekklesia's module-development packages (@ekklesia/*) come from Ekklesia's public package registry
|
||||||
|
# (platform ADRs 0053 and 0054). Reading needs no account and no token; never put a credential here.
|
||||||
|
@ekklesia:registry=https://git.riverofglorymn.org/api/packages/River_of_Glory_Church/npm/
|
||||||
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
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.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
@@ -51,70 +51,71 @@ Mounting requires an authenticated module descriptor, and Core does not yet cach
|
|||||||
cold start depends on a Core-provided authorized offline display descriptor or lease; until that
|
cold start depends on a Core-provided authorized offline display descriptor or lease; until that
|
||||||
exists, this module does not claim it. See ADR 0006.
|
exists, this module does not claim it. See ADR 0006.
|
||||||
|
|
||||||
## Developing against Ekklesia
|
## Developing Signage
|
||||||
|
|
||||||
Signage is developed **inside the authoritative Ekklesia workspace**, checked out at the path it will
|
Signage builds and tests on its own. You need no Ekklesia checkout and no Ekklesia account:
|
||||||
eventually be installed at:
|
|
||||||
|
- **Node.js** in the range `engines.node` declares (`>=24.11.0 <25`); `.node-version` names the
|
||||||
|
version CI uses.
|
||||||
|
- **pnpm** at the version `packageManager` pins, through Corepack (`corepack enable`).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone <ekklesia> ekklesia
|
git clone <this repository> signage
|
||||||
git clone <this repository> ekklesia/modules/signage
|
cd signage
|
||||||
cd ekklesia
|
corepack enable
|
||||||
pnpm install
|
pnpm install --frozen-lockfile
|
||||||
```
|
```
|
||||||
|
|
||||||
`modules/*` is an Ekklesia workspace glob, so the checkout is picked up with no registry edit,
|
Ekklesia's module-development packages (`@ekklesia/module-sdk`, `@ekklesia/module-database`,
|
||||||
no second copy of Ekklesia, and no vendored SDK. `@ekklesia/module-sdk`, `@ekklesia/module-database`,
|
`@ekklesia/module-ui-sdk`, `@ekklesia/ui`, `@ekklesia/design-tokens`, `@ekklesia/module-ui-build`,
|
||||||
`@ekklesia/module-ui-sdk`, `@ekklesia/design-tokens`, `@ekklesia/ui`, and `@ekklesia/module-ui-build`
|
`@ekklesia/module-pack`, `@ekklesia/typescript-config`) come from Ekklesia's public package registry.
|
||||||
all resolve through the workspace as `workspace:*` dependencies.
|
The committed `.npmrc` points the `@ekklesia` scope at it, and reading it needs **no token** and no
|
||||||
|
login (platform ADRs 0053 and 0054); never add a credential to that file. Everything else comes from
|
||||||
|
the public npm registry. `package.json` takes the Ekklesia packages as `^0.2.0` ranges, except
|
||||||
|
`@ekklesia/module-pack`, which is pinned exactly; `pnpm-lock.yaml` pins every package's exact version
|
||||||
|
and integrity, so always install with `--frozen-lockfile` unless you mean to change a dependency.
|
||||||
|
|
||||||
Two consequences worth knowing:
|
`pnpm-workspace.yaml` holds this repository's own pnpm settings: it allows esbuild's install script,
|
||||||
|
exempts exactly the Ekklesia package train in the lockfile from pnpm's minimum release age, and keeps
|
||||||
|
one narrowly scoped advisory override. It does not make Signage part of any other workspace.
|
||||||
|
|
||||||
- Ekklesia uses a shared workspace lockfile, so installing here writes an importer entry for
|
Signage requires Ekklesia 0.2: manifest version 8 and the Module Database ABI v1 (platform ADR 0050).
|
||||||
`modules/signage` into Ekklesia's `pnpm-lock.yaml`. That entry belongs to whoever maintains the
|
It reaches PostgreSQL only through the ABI v1 executor the platform hands it, with its own Drizzle
|
||||||
Ekklesia checkout; it is not committed from this repository.
|
tables and the module-side adapter from `@ekklesia/module-database/drizzle`. Core receives SQL text,
|
||||||
- Signage requires Ekklesia 0.2: manifest version 8 and the Module Database ABI v1 (platform ADR
|
bound values, and plain schema metadata, never a Drizzle object.
|
||||||
0050), on top of the prerequisites for shared design tokens, module stylesheets, browser
|
|
||||||
contributions, bounded streaming request bodies, and display offline code (ADRs 0039–0043). An
|
|
||||||
older Ekklesia checkout cannot build or validate this module.
|
|
||||||
- Signage reaches PostgreSQL only through the ABI v1 executor the platform hands it, with its own
|
|
||||||
Drizzle tables and the module-side adapter from `@ekklesia/module-database/drizzle`. Core receives
|
|
||||||
SQL text, bound values, and plain schema metadata, never a Drizzle object.
|
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
|
|
||||||
Run from the **Ekklesia repository root**:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm --filter @ekklesia/signage build # tsc + the canonical module UI build
|
pnpm lint # Biome, with this repository's biome.json
|
||||||
pnpm --filter @ekklesia/signage test # unit and browser-artifact tests
|
pnpm typecheck # node, browser, and browser-test projects
|
||||||
pnpm --filter @ekklesia/signage typecheck # node, browser, and browser-test projects
|
pnpm test # unit, browser-artifact, and display contract tests (vitest.config.ts)
|
||||||
pnpm --filter @ekklesia/signage lint
|
pnpm build # tsc, then the canonical module UI build of the primary and display artifacts
|
||||||
|
pnpm validate # after build: the built package and its migrations, as the platform reads them
|
||||||
pnpm boundaries # four-layer boundary enforcement
|
|
||||||
pnpm modules:validate # static manifest, entrypoint, and schema validation
|
|
||||||
pnpm migrations:validate # migration journal, policy, ordering, and checksums
|
|
||||||
pnpm verify # the full Docker-free gate
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Signage's tests are its own: `pnpm test` here runs `vitest` against this package's `vitest.config.ts`,
|
CI runs exactly these, from a clean checkout.
|
||||||
which includes `.test.tsx` as well as `.test.ts`. The workspace-root config includes only `.test.ts`,
|
|
||||||
so a browser test added here without that config would be silently skipped.
|
|
||||||
|
|
||||||
Never run `pnpm migrations:apply` against a persistent database while developing this module. Signage
|
`pnpm validate` uses only the published SDK parsers. It cannot check what only an Ekklesia
|
||||||
reads no environment variable, constructs no database client, configures no object storage, hardcodes
|
installation knows: compatibility with that installation, other installed modules' capabilities and
|
||||||
no Ekklesia URL, opens no socket of its own, and applies no migration: every one of those reaches it
|
dependencies, or a migration's checksum against a database's applied history. Ekklesia checks those
|
||||||
|
when Signage is installed.
|
||||||
|
|
||||||
|
Never run a migration against a persistent database while developing this module. Signage reads no
|
||||||
|
environment variable, constructs no database client, configures no object storage, hardcodes no
|
||||||
|
Ekklesia URL, opens no socket of its own, and applies no migration: every one of those reaches it
|
||||||
through the host.
|
through the host.
|
||||||
|
|
||||||
### Changing the schema
|
### Changing the schema
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pnpm --filter @ekklesia/signage migration:generate # drizzle-kit, into drizzle/
|
pnpm migration:generate # drizzle-kit, into drizzle/
|
||||||
```
|
```
|
||||||
|
|
||||||
`tests/schema.test.ts` pins the checksum of the generated SQL, so a regenerated migration fails the
|
`tests/schema.test.ts` pins the checksum of the generated SQL, so a regenerated migration fails the
|
||||||
suite until the pin is updated deliberately. `drizzle/meta/_ekklesia.json` declares the migration
|
suite until the pin is updated deliberately. `drizzle/meta/_ekklesia.json` declares the migration
|
||||||
non-destructive; `pnpm migrations:validate` enforces that.
|
non-destructive: `tests/schema.test.ts` asserts it, and Ekklesia's own migration validation enforces
|
||||||
|
it when Signage is packaged and installed.
|
||||||
|
|
||||||
### Verifying what only a browser can show
|
### Verifying what only a browser can show
|
||||||
|
|
||||||
|
|||||||
+34
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://biomejs.dev/schemas/2.5.3/schema.json",
|
||||||
|
"files": {
|
||||||
|
"includes": [
|
||||||
|
"**",
|
||||||
|
"!**/.pnpm-store",
|
||||||
|
"!**/.turbo",
|
||||||
|
"!**/build",
|
||||||
|
"!**/coverage",
|
||||||
|
"!**/dist",
|
||||||
|
"!**/node_modules",
|
||||||
|
"!pnpm-lock.yaml"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"formatter": {
|
||||||
|
"enabled": true,
|
||||||
|
"indentStyle": "space",
|
||||||
|
"indentWidth": 2,
|
||||||
|
"lineWidth": 100
|
||||||
|
},
|
||||||
|
"linter": {
|
||||||
|
"enabled": true,
|
||||||
|
"rules": {
|
||||||
|
"preset": "recommended"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"javascript": {
|
||||||
|
"formatter": {
|
||||||
|
"quoteStyle": "double",
|
||||||
|
"semicolons": "always",
|
||||||
|
"trailingCommas": "all"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# Assembles Signage into the Ekklesia platform it is tested against: the platform at the commit pinned
|
|
||||||
# in ci/platform.env, this checkout at modules/signage, and ci/pnpm-lock.yaml as the workspace
|
|
||||||
# lockfile. Signage cannot build or run outside an Ekklesia workspace, so every CI job starts here.
|
|
||||||
#
|
|
||||||
# bash ci/assemble.sh [--allow-missing-lock] [output directory]
|
|
||||||
#
|
|
||||||
# The output directory (default build/workspace) is deleted and recreated. The platform is fetched
|
|
||||||
# by its `main` branch and the pinned commit must be on it, so CI only ever runs reviewed platform
|
|
||||||
# code; the checkout is then by commit, so nothing after it depends on a ref the network can move.
|
|
||||||
# Every .git directory is removed afterwards.
|
|
||||||
#
|
|
||||||
# --allow-missing-lock keeps the platform's own lockfile. Only ci/update-lock.sh uses it.
|
|
||||||
set -Eeuo pipefail
|
|
||||||
|
|
||||||
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
||||||
allow_missing_lock=0
|
|
||||||
if [[ "${1:-}" == "--allow-missing-lock" ]]; then
|
|
||||||
allow_missing_lock=1
|
|
||||||
shift
|
|
||||||
fi
|
|
||||||
out="${1:-$root/build/workspace}"
|
|
||||||
|
|
||||||
fail() {
|
|
||||||
echo "assemble: $*" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
for command in git tar; do
|
|
||||||
command -v "$command" >/dev/null || fail "$command is required."
|
|
||||||
done
|
|
||||||
|
|
||||||
# Read the two pins without sourcing the file: it is data, not a script.
|
|
||||||
pin() {
|
|
||||||
local value
|
|
||||||
value="$(sed -n "s/^$1=//p" "$root/ci/platform.env")"
|
|
||||||
[[ -n "$value" ]] || fail "ci/platform.env has no $1."
|
|
||||||
printf '%s' "$value"
|
|
||||||
}
|
|
||||||
repository="$(pin EKKLESIA_PLATFORM_REPOSITORY)"
|
|
||||||
commit="$(pin EKKLESIA_PLATFORM_COMMIT)"
|
|
||||||
[[ "$commit" =~ ^[0-9a-f]{40}$ ]] || fail "EKKLESIA_PLATFORM_COMMIT must be a full commit SHA."
|
|
||||||
|
|
||||||
rm -rf "$out"
|
|
||||||
mkdir -p "$(dirname -- "$out")"
|
|
||||||
git init --quiet "$out"
|
|
||||||
git -C "$out" remote add origin "$repository"
|
|
||||||
git -C "$out" fetch --quiet --no-tags origin "+refs/heads/main:refs/remotes/origin/main" ||
|
|
||||||
fail "cannot fetch the platform's main from ${repository}."
|
|
||||||
git -C "$out" cat-file -e "${commit}^{commit}" 2>/dev/null ||
|
|
||||||
fail "the pinned platform commit ${commit} is not on the platform's main."
|
|
||||||
git -C "$out" merge-base --is-ancestor "$commit" refs/remotes/origin/main ||
|
|
||||||
fail "the pinned platform commit ${commit} is not on the platform's main."
|
|
||||||
git -C "$out" -c advice.detachedHead=false checkout --quiet --detach "$commit"
|
|
||||||
[[ "$(git -C "$out" rev-parse HEAD)" == "$commit" ]] || fail "the platform did not check out at ${commit}."
|
|
||||||
rm -rf "$out/.git"
|
|
||||||
echo "assemble: platform ${commit}"
|
|
||||||
|
|
||||||
[[ ! -e "$out/modules/signage" ]] || fail "the platform checkout already has modules/signage."
|
|
||||||
mkdir -p "$out/modules/signage"
|
|
||||||
# Exactly the files this checkout tracks, as committed or as changed in the working tree. Nothing
|
|
||||||
# installed, built, or ignored, and not the CI scaffolding, which is not part of the module.
|
|
||||||
git -C "$root" ls-files -z --cached --others --exclude-standard -- . ':!ci' ':!.gitea' |
|
|
||||||
tar -C "$root" --null --files-from=- --create --file=- |
|
|
||||||
tar -C "$out/modules/signage" --extract --file=-
|
|
||||||
echo "assemble: signage $(git -C "$root" rev-parse HEAD 2>/dev/null || echo "(working tree)")"
|
|
||||||
|
|
||||||
if [[ -f "$root/ci/pnpm-lock.yaml" ]]; then
|
|
||||||
cp "$root/ci/pnpm-lock.yaml" "$out/pnpm-lock.yaml"
|
|
||||||
elif ((allow_missing_lock == 0)); then
|
|
||||||
fail "ci/pnpm-lock.yaml is missing; run bash ci/update-lock.sh."
|
|
||||||
fi
|
|
||||||
+8
-3
@@ -6,7 +6,7 @@
|
|||||||
#
|
#
|
||||||
# The `integration` job is the one that starts Docker stacks. It must have its own
|
# The `integration` job is the one that starts Docker stacks. It must have its own
|
||||||
# EKKLESIA_CI_JOB_KEY, sweep stale CI stacks before it starts anything, and remove its own in a final
|
# EKKLESIA_CI_JOB_KEY, sweep stale CI stacks before it starts anything, and remove its own in a final
|
||||||
# `if: always()` step; and the image ci/integration.sh builds must carry the CI labels the sweep finds.
|
# `if: always()` step. The pinned platform smoke owns and labels every image and container.
|
||||||
set -Eeuo pipefail
|
set -Eeuo pipefail
|
||||||
|
|
||||||
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
@@ -31,13 +31,18 @@ own="$(line_of 'ci-sweep.sh --job')"
|
|||||||
last_step="$(grep -n -- " - name:" <<<"$job" | tail -1 | cut -d: -f1 || true)"
|
last_step="$(grep -n -- " - name:" <<<"$job" | tail -1 | cut -d: -f1 || true)"
|
||||||
|
|
||||||
check '[[ -n "$job" ]]' "the workflow has an integration job"
|
check '[[ -n "$job" ]]' "the workflow has an integration job"
|
||||||
|
check '! grep -q "if: false" <<<"$job"' "the integration job is enabled"
|
||||||
check 'grep -q "EKKLESIA_CI_JOB_KEY:" <<<"$job"' "the integration job names its stacks with its own key"
|
check 'grep -q "EKKLESIA_CI_JOB_KEY:" <<<"$job"' "the integration job names its stacks with its own key"
|
||||||
check '[[ -n "$stale" && -n "$run" ]] && ((stale < run))' "it sweeps stale CI stacks before it starts anything"
|
check '[[ -n "$stale" && -n "$run" ]] && ((stale < run))' "it sweeps stale CI stacks before it starts anything"
|
||||||
check '[[ -n "$own" && -n "$run" ]] && ((own > run)) && ((own > last_step))' \
|
check '[[ -n "$own" && -n "$run" ]] && ((own > run)) && ((own > last_step))' \
|
||||||
"its last step removes its own stacks"
|
"its last step removes its own stacks"
|
||||||
check 'sed -n "${last_step},\$p" <<<"$job" | grep -q "if: always()"' "that last step always runs"
|
check 'sed -n "${last_step},\$p" <<<"$job" | grep -q "if: always()"' "that last step always runs"
|
||||||
check 'grep -q "EKKLESIA_CI_LABEL" "$root/ci/integration.sh" && grep -q "EKKLESIA_CI_CREATED_LABEL" "$root/ci/integration.sh"' \
|
check 'grep -q "EKKLESIA_SMOKE_MODULE_RELEASE_DIR" "$root/ci/integration.sh" && grep -q "bash scripts/smoke-deploy.sh" "$root/ci/integration.sh"' \
|
||||||
"the image ci/integration.sh builds carries the CI labels"
|
"the integration delegates its external package to the platform smoke"
|
||||||
|
check 'grep -Eq "^EKKLESIA_PLATFORM_REF=refs/(pull/[0-9]+/head|heads/main)$" "$root/ci/platform.env" && grep -Eq "^EKKLESIA_PLATFORM_COMMIT=[0-9a-f]{40}$" "$root/ci/platform.env"' \
|
||||||
|
"the platform harness is pinned by full ref and commit"
|
||||||
|
check 'grep -q "rev-parse refs/remotes/pinned" "$root/ci/fetch-platform.sh" && grep -q "does not resolve to EKKLESIA_PLATFORM_COMMIT" "$root/ci/fetch-platform.sh"' \
|
||||||
|
"the fetch verifies that the pinned ref resolves to the pinned commit"
|
||||||
|
|
||||||
((failures == 0)) || {
|
((failures == 0)) || {
|
||||||
echo "check-cleanup: ${failures} check(s) failed." >&2
|
echo "check-cleanup: ${failures} check(s) failed." >&2
|
||||||
|
|||||||
Executable
+39
@@ -0,0 +1,39 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Fetches the exact Ekklesia source revision Signage's external-package integration runs against.
|
||||||
|
# The ref is fetched only to make the pinned object reachable; the checkout is always by full SHA.
|
||||||
|
set -Eeuo pipefail
|
||||||
|
|
||||||
|
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
|
out="$root/build/platform"
|
||||||
|
|
||||||
|
fail() {
|
||||||
|
echo "fetch-platform: $*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
(($# == 0)) || fail "this command takes no arguments."
|
||||||
|
|
||||||
|
pin() {
|
||||||
|
local value
|
||||||
|
value="$(sed -n "s/^$1=//p" "$root/ci/platform.env")"
|
||||||
|
[[ -n "$value" ]] || fail "ci/platform.env has no $1."
|
||||||
|
printf '%s' "$value"
|
||||||
|
}
|
||||||
|
|
||||||
|
repository="$(pin EKKLESIA_PLATFORM_REPOSITORY)"
|
||||||
|
ref="$(pin EKKLESIA_PLATFORM_REF)"
|
||||||
|
commit="$(pin EKKLESIA_PLATFORM_COMMIT)"
|
||||||
|
[[ "$commit" =~ ^[0-9a-f]{40}$ ]] || fail "EKKLESIA_PLATFORM_COMMIT must be a full commit SHA."
|
||||||
|
[[ "$ref" == refs/* ]] || fail "EKKLESIA_PLATFORM_REF must be a full Git ref."
|
||||||
|
|
||||||
|
rm -rf "$out"
|
||||||
|
mkdir -p "$out"
|
||||||
|
git -C "$out" init --quiet
|
||||||
|
git -C "$out" remote add origin "$repository"
|
||||||
|
git -C "$out" fetch --quiet --no-tags --depth=1 origin "+${ref}:refs/remotes/pinned" ||
|
||||||
|
fail "cannot fetch the pinned platform ref."
|
||||||
|
[[ "$(git -C "$out" rev-parse refs/remotes/pinned)" == "$commit" ]] ||
|
||||||
|
fail "the pinned ref does not resolve to EKKLESIA_PLATFORM_COMMIT."
|
||||||
|
git -C "$out" -c advice.detachedHead=false checkout --quiet --detach "$commit"
|
||||||
|
rm -rf "$out/.git"
|
||||||
|
echo "fetch-platform: Ekklesia ${commit}"
|
||||||
+27
-23
@@ -1,42 +1,46 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# Signage inside Ekklesia, end to end: builds the deployment image from the assembled workspace with
|
# Builds Signage as the canonical linux-x64-glibc Module Package, then gives that exact release pair
|
||||||
# the platform's own Dockerfile, then runs the platform's split-topology deployment smoke against it
|
# to the pinned platform's generic deployment smoke. The platform image contains no Signage source:
|
||||||
# with the display-device scenarios listed in ci/display-scenarios. A disposable PostgreSQL and object
|
# its verifier extracts the package into installation-owned module storage before migrations,
|
||||||
# store, generated secrets, and an explicit migration apply against that fresh database only; nothing
|
# discovery, browser UI/display checks, restart, container recreation, disable/re-enable, removal,
|
||||||
# is pushed, published, or logged in to. The image is removed afterwards.
|
# and reinstall are exercised against disposable PostgreSQL and object-storage services.
|
||||||
#
|
#
|
||||||
# bash ci/integration.sh (after bash ci/assemble.sh)
|
# bash ci/fetch-platform.sh
|
||||||
|
# bash ci/integration.sh
|
||||||
set -Eeuo pipefail
|
set -Eeuo pipefail
|
||||||
|
|
||||||
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
workspace="$root/build/workspace"
|
platform="$root/build/platform"
|
||||||
[[ -f "$workspace/deploy/Dockerfile" ]] || {
|
release="$root/build/module-package"
|
||||||
echo "integration: run bash ci/assemble.sh first." >&2
|
[[ -f "$platform/scripts/smoke-deploy.sh" ]] || {
|
||||||
|
echo "integration: run bash ci/fetch-platform.sh first." >&2
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
# Named and labeled as a CI stack of this run and job (the platform's scripts/lib/ci-project.sh), so
|
source_revision="${GITHUB_SHA:-$(git -C "$root" rev-parse HEAD 2>/dev/null || true)}"
|
||||||
# the workflow's final `ci-sweep.sh --job` removes it even if this script is killed before its trap.
|
[[ "$source_revision" =~ ^[0-9a-f]{40}$ ]] || {
|
||||||
# shellcheck source=/dev/null
|
echo "integration: no full source revision is available for the package." >&2
|
||||||
source "$workspace/scripts/lib/ci-project.sh"
|
exit 1
|
||||||
project="$(ci_project_name signage-image)"
|
}
|
||||||
image="${project}:latest"
|
|
||||||
trap 'docker image rm --force "$image" >/dev/null 2>&1 || true' EXIT
|
rm -rf "$release"
|
||||||
|
mkdir -p "$release"
|
||||||
|
pnpm --dir "$root" build
|
||||||
|
pnpm --dir "$root" exec ekklesia-pack-module --module "$root" --target linux-x64-glibc \
|
||||||
|
--out "$release" --license-file "$root/LICENSE" --source-revision "$source_revision"
|
||||||
|
|
||||||
scenarios="$(sed -e 's/#.*//' -e '/^[[:space:]]*$/d' "$root/ci/display-scenarios" | tr '\n' ' ')"
|
scenarios="$(sed -e 's/#.*//' -e '/^[[:space:]]*$/d' "$root/ci/display-scenarios" | tr '\n' ' ')"
|
||||||
[[ -n "${scenarios// /}" ]] || {
|
[[ -n "${scenarios// /}" ]] || {
|
||||||
echo "integration: ci/display-scenarios lists no scenario." >&2
|
echo "integration: ci/display-scenarios lists no scenario." >&2
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
echo "integration: external Signage package built; scenarios: ${scenarios}"
|
||||||
|
|
||||||
DOCKER_BUILDKIT=1 docker build --quiet --file "$workspace/deploy/Dockerfile" --tag "$image" \
|
cd "$platform"
|
||||||
--label "${EKKLESIA_CI_LABEL}=${project}" --label "${EKKLESIA_CI_CREATED_LABEL}=$(date +%s)" \
|
|
||||||
"$workspace" >/dev/null
|
|
||||||
echo "integration: built the deployment image with Signage; scenarios: ${scenarios}"
|
|
||||||
|
|
||||||
cd "$workspace"
|
|
||||||
EKKLESIA_SMOKE_TOPOLOGY=split \
|
EKKLESIA_SMOKE_TOPOLOGY=split \
|
||||||
EKKLESIA_SMOKE_IMAGE="$image" \
|
EKKLESIA_SMOKE_MODULE_RELEASE_DIR="$release" \
|
||||||
|
EKKLESIA_SMOKE_MODULE_ID=signage \
|
||||||
|
EKKLESIA_SMOKE_MODULE_PROBE_PATH=/api/v1/modules/signage/channel-groups \
|
||||||
EKKLESIA_SMOKE_DISPLAY_DEVICE=1 \
|
EKKLESIA_SMOKE_DISPLAY_DEVICE=1 \
|
||||||
EKKLESIA_SMOKE_DISPLAY_SCENARIOS="$scenarios" \
|
EKKLESIA_SMOKE_DISPLAY_SCENARIOS="$scenarios" \
|
||||||
EKKLESIA_SMOKE_WATCH_MS=120000 \
|
EKKLESIA_SMOKE_WATCH_MS=120000 \
|
||||||
|
|||||||
+4
-5
@@ -1,6 +1,5 @@
|
|||||||
# The Ekklesia platform Signage's CI builds and tests against: one reviewed commit on the platform's
|
# The companion Core harness Signage uses to install and run its real external package. The pull ref
|
||||||
# `main`, never a moving ref. ci/assemble.sh refuses a commit that is not on `main`.
|
# remains reachable after its branch is deleted; the full commit pin makes the checkout immutable.
|
||||||
#
|
|
||||||
# Move it deliberately: change the commit, run `bash ci/update-lock.sh`, and commit both.
|
|
||||||
EKKLESIA_PLATFORM_REPOSITORY=https://git.riverofglorymn.org/River_of_Glory_Church/Ekklesia.git
|
EKKLESIA_PLATFORM_REPOSITORY=https://git.riverofglorymn.org/River_of_Glory_Church/Ekklesia.git
|
||||||
EKKLESIA_PLATFORM_COMMIT=1788d17f0ab618ebc41550728da865d14cdd7a75
|
EKKLESIA_PLATFORM_REF=refs/pull/90/head
|
||||||
|
EKKLESIA_PLATFORM_COMMIT=40ef0ff802c124ae5a3a0b9aa51a1502a7b72644
|
||||||
|
|||||||
Generated
-4503
File diff suppressed because it is too large
Load Diff
@@ -1,21 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# Regenerates ci/pnpm-lock.yaml: the lockfile of Signage assembled into the pinned platform. Run it
|
|
||||||
# after changing Signage's dependencies or ci/platform.env, and commit the result. CI installs with
|
|
||||||
# --frozen-lockfile, so a stale lockfile fails there rather than resolving anything new.
|
|
||||||
#
|
|
||||||
# bash ci/update-lock.sh
|
|
||||||
#
|
|
||||||
# Uses the platform's own pinned pnpm (its packageManager field) through Corepack.
|
|
||||||
set -Eeuo pipefail
|
|
||||||
|
|
||||||
root="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
||||||
work="$(mktemp -d)"
|
|
||||||
trap 'rm -rf "$work"' EXIT
|
|
||||||
|
|
||||||
bash "$root/ci/assemble.sh" --allow-missing-lock "$work/workspace"
|
|
||||||
cd "$work/workspace"
|
|
||||||
corepack enable >/dev/null 2>&1 || true
|
|
||||||
corepack install >/dev/null
|
|
||||||
pnpm install --lockfile-only
|
|
||||||
cp pnpm-lock.yaml "$root/ci/pnpm-lock.yaml"
|
|
||||||
echo "update-lock: wrote ci/pnpm-lock.yaml"
|
|
||||||
+17
-10
@@ -2,7 +2,12 @@
|
|||||||
"name": "@ekklesia/signage",
|
"name": "@ekklesia/signage",
|
||||||
"version": "0.1.2",
|
"version": "0.1.2",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"license": "AGPL-3.0-or-later",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"packageManager": "[email protected]",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=24.11.0 <25"
|
||||||
|
},
|
||||||
"description": "Ekklesia's visual programming, timeline, synchronization, and display-delivery module.",
|
"description": "Ekklesia's visual programming, timeline, synchronization, and display-delivery module.",
|
||||||
"files": [
|
"files": [
|
||||||
"dist",
|
"dist",
|
||||||
@@ -23,25 +28,27 @@
|
|||||||
"build": "tsc --project tsconfig.build.json && ekklesia-build-module-ui",
|
"build": "tsc --project tsconfig.build.json && ekklesia-build-module-ui",
|
||||||
"lint": "biome lint .",
|
"lint": "biome lint .",
|
||||||
"migration:generate": "drizzle-kit generate --config=drizzle.config.ts",
|
"migration:generate": "drizzle-kit generate --config=drizzle.config.ts",
|
||||||
"prepack": "pnpm --workspace-root exec turbo run build --filter=@ekklesia/signage",
|
"prepack": "pnpm run build",
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
"typecheck": "tsc --noEmit --project tsconfig.json && tsc --noEmit --project tsconfig.ui.json && tsc --noEmit --project tsconfig.ui-test.json"
|
"typecheck": "tsc --noEmit --project tsconfig.json && tsc --noEmit --project tsconfig.ui.json && tsc --noEmit --project tsconfig.ui-test.json",
|
||||||
|
"validate": "node scripts/validate-module.mjs"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@ekklesia/design-tokens": "workspace:*",
|
"@ekklesia/design-tokens": "^0.2.3",
|
||||||
"@ekklesia/module-database": "workspace:*",
|
"@ekklesia/module-database": "^0.2.3",
|
||||||
"@ekklesia/module-sdk": "workspace:*",
|
"@ekklesia/module-sdk": "^0.2.3",
|
||||||
"@ekklesia/module-ui-sdk": "workspace:*",
|
"@ekklesia/module-ui-sdk": "^0.2.3",
|
||||||
"@ekklesia/ui": "workspace:*",
|
"@ekklesia/ui": "^0.2.3",
|
||||||
"drizzle-orm": "0.45.2",
|
"drizzle-orm": "0.45.2",
|
||||||
"react": "19.2.8",
|
"react": "19.2.8",
|
||||||
"react-dom": "19.2.8",
|
"react-dom": "19.2.8",
|
||||||
"sharp": "0.35.4"
|
"sharp": "0.35.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "2.5.3",
|
"@biomejs/biome": "2.5.3",
|
||||||
"@ekklesia/module-ui-build": "workspace:*",
|
"@ekklesia/module-pack": "0.2.3",
|
||||||
"@ekklesia/typescript-config": "workspace:*",
|
"@ekklesia/module-ui-build": "^0.2.3",
|
||||||
|
"@ekklesia/typescript-config": "^0.2.3",
|
||||||
"@types/node": "24.13.3",
|
"@types/node": "24.13.3",
|
||||||
"@types/react": "19.2.18",
|
"@types/react": "19.2.18",
|
||||||
"@types/react-dom": "19.2.4",
|
"@types/react-dom": "19.2.4",
|
||||||
|
|||||||
Generated
+2556
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,30 @@
|
|||||||
|
# This repository's own pnpm settings. Signage is a single standalone package, not part of any other
|
||||||
|
# workspace; pnpm reads its settings from this file.
|
||||||
|
|
||||||
|
# esbuild, which the module UI build and the module packager run, has an install script. pnpm runs
|
||||||
|
# none it was not told to.
|
||||||
|
allowBuilds:
|
||||||
|
esbuild: true
|
||||||
|
|
||||||
|
# pnpm holds back any package younger than its minimum release age, and refuses a lockfile that names
|
||||||
|
# one. A new Ekklesia package train is that young on its release day. These exact versions, and only
|
||||||
|
# these, are the train this lockfile pins (published by Ekklesia's release workflow, ADR 0053), so
|
||||||
|
# they are exempt by version; a train bump replaces them, and everything else keeps the policy.
|
||||||
|
minimumReleaseAgeExclude:
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
- '@ekklesia/[email protected]'
|
||||||
|
|
||||||
|
# The narrowly scoped advisory remediation Signage had while it was built inside Ekklesia's workspace,
|
||||||
|
# kept now that it is not. GHSA-67mh-4wv8-2f99 (moderate): the vulnerable esbuild 0.18.20 is reached
|
||||||
|
# only through the deprecated @esbuild-kit/core-utils (drizzle-kit -> @esbuild-kit/esm-loader), whose
|
||||||
|
# pinned range predates the fix. Scoped to that one edge, exactly as Ekklesia's own workspace does,
|
||||||
|
# so drizzle-kit's direct esbuild and Vite's are not dragged to another version.
|
||||||
|
overrides:
|
||||||
|
"@esbuild-kit/core-utils>esbuild": "0.25.12"
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
// Validates the built Signage package and its migrations the way the platform reads them, with only
|
||||||
|
// Ekklesia's published module-development packages: no Ekklesia checkout, no database.
|
||||||
|
//
|
||||||
|
// pnpm build && pnpm validate
|
||||||
|
//
|
||||||
|
// What it checks:
|
||||||
|
// - the manifest parses, and its id and version match package.json and the built runtime;
|
||||||
|
// - every declared entrypoint exists in the built package;
|
||||||
|
// - the built runtime declares the same Module Database ABI as the manifest (Core refuses a
|
||||||
|
// mismatch);
|
||||||
|
// - the built schema entrypoint's only export is plain ABI v1 metadata for this module's own,
|
||||||
|
// namespaced tables, and every foreign key targets one of them;
|
||||||
|
// - the installed module SDK satisfies the manifest's `compatibility.moduleSdk`;
|
||||||
|
// - the migration journal and policy parse, name the same migrations in the same order, and every
|
||||||
|
// migration's SQL is present.
|
||||||
|
//
|
||||||
|
// What it cannot check, because only Ekklesia itself can: compatibility with a particular platform
|
||||||
|
// installation, capability and module dependencies between installed modules, and a migration's
|
||||||
|
// checksum against a database's applied history. The module packager and the platform's package
|
||||||
|
// verifier re-check all of the above when Signage is built as a Module Package.
|
||||||
|
import { readFile, stat } from "node:fs/promises";
|
||||||
|
import { fileURLToPath, pathToFileURL } from "node:url";
|
||||||
|
import { defineModuleSchemaMetadata, moduleTablePrefix } from "@ekklesia/module-database";
|
||||||
|
import {
|
||||||
|
parseDrizzleMigrationJournal,
|
||||||
|
parseModuleManifest,
|
||||||
|
parseModuleMigrationPolicy,
|
||||||
|
} from "@ekklesia/module-sdk";
|
||||||
|
|
||||||
|
const root = fileURLToPath(new URL("..", import.meta.url));
|
||||||
|
const failures = [];
|
||||||
|
const passes = [];
|
||||||
|
|
||||||
|
function check(condition, description) {
|
||||||
|
(condition ? passes : failures).push(description);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function json(relative) {
|
||||||
|
return JSON.parse(await readFile(new URL(relative, pathToFileURL(root)), "utf8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function exists(relative) {
|
||||||
|
try {
|
||||||
|
return (await stat(new URL(relative, pathToFileURL(root)))).isFile();
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A caret range, `^X.Y.Z`, as the platform's manifests write them. Anything else is refused here
|
||||||
|
* rather than half understood. */
|
||||||
|
function satisfiesCaret(version, range) {
|
||||||
|
const wanted = /^\^(\d+)\.(\d+)\.(\d+)$/u.exec(range);
|
||||||
|
const actual = /^(\d+)\.(\d+)\.(\d+)$/u.exec(version);
|
||||||
|
if (!wanted || !actual) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const [w, a] = [wanted.slice(1).map(Number), actual.slice(1).map(Number)];
|
||||||
|
if (w[0] !== a[0] || (w[0] === 0 && w[1] !== a[1])) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
for (let index = 0; index < 3; index += 1) {
|
||||||
|
if (a[index] !== w[index]) {
|
||||||
|
return a[index] > w[index];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const packageJson = await json("package.json");
|
||||||
|
const manifest = parseModuleManifest(await json("ekklesia.module.json"));
|
||||||
|
check(true, "ekklesia.module.json is a valid manifest");
|
||||||
|
check(packageJson.version === manifest.version, "package.json and the manifest name one version");
|
||||||
|
check(packageJson.type === "module", "the package is ESM");
|
||||||
|
check(packageJson.ekklesia?.layer === "module", "the package carries the module layer marker");
|
||||||
|
|
||||||
|
const { server, schema, migrations, ui, display } = manifest.entrypoints;
|
||||||
|
for (const entrypoint of [server, schema, ui, display?.artifact].filter(Boolean)) {
|
||||||
|
check(await exists(entrypoint), `the built package has ${entrypoint}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const runtime = (await import(new URL(server, pathToFileURL(root)).href)).default;
|
||||||
|
check(runtime?.id === manifest.id, "the built runtime's id is the manifest's");
|
||||||
|
check(runtime?.version === manifest.version, "the built runtime's version is the manifest's");
|
||||||
|
check(
|
||||||
|
JSON.stringify(runtime?.database ?? null) === JSON.stringify(manifest.database ?? null),
|
||||||
|
"the built runtime declares the manifest's database ABI",
|
||||||
|
);
|
||||||
|
|
||||||
|
if (schema) {
|
||||||
|
const namespace = await import(new URL(schema, pathToFileURL(root)).href);
|
||||||
|
check(
|
||||||
|
Object.keys(namespace).join() === "default",
|
||||||
|
"the schema entrypoint exports nothing but its metadata",
|
||||||
|
);
|
||||||
|
const metadata = defineModuleSchemaMetadata(namespace.default);
|
||||||
|
check(
|
||||||
|
JSON.stringify(JSON.parse(JSON.stringify(metadata))) === JSON.stringify(metadata),
|
||||||
|
"the schema metadata is plain data",
|
||||||
|
);
|
||||||
|
check(metadata.moduleId === manifest.id, "the schema metadata is this module's");
|
||||||
|
const prefix = moduleTablePrefix(manifest.id);
|
||||||
|
const owned = new Set(metadata.tables.map((table) => table.name));
|
||||||
|
check(
|
||||||
|
metadata.tables.every((table) => table.name.startsWith(prefix)),
|
||||||
|
`every table is in the ${prefix} namespace`,
|
||||||
|
);
|
||||||
|
check(
|
||||||
|
metadata.tables.every((table) => table.foreignKeys.every((key) => owned.has(key.table))),
|
||||||
|
"every foreign key targets one of this module's own tables",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const sdkVersion = (await json("node_modules/@ekklesia/module-sdk/package.json")).version;
|
||||||
|
check(
|
||||||
|
satisfiesCaret(sdkVersion, manifest.compatibility.moduleSdk),
|
||||||
|
`the installed module SDK ${sdkVersion} satisfies compatibility.moduleSdk ${manifest.compatibility.moduleSdk}`,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (migrations) {
|
||||||
|
const directory = migrations.endsWith("/") ? migrations : `${migrations}/`;
|
||||||
|
const journal = parseDrizzleMigrationJournal(await json(`${directory}meta/_journal.json`));
|
||||||
|
const policy = parseModuleMigrationPolicy(await json(`${directory}meta/_ekklesia.json`));
|
||||||
|
check(policy.moduleId === manifest.id, "the migration policy is this module's");
|
||||||
|
check(
|
||||||
|
journal.entries.map((entry) => entry.tag).join() ===
|
||||||
|
policy.entries.map((entry) => entry.tag).join(),
|
||||||
|
"the migration journal and policy name the same migrations in the same order",
|
||||||
|
);
|
||||||
|
for (const entry of journal.entries) {
|
||||||
|
check(await exists(`${directory}${entry.tag}.sql`), `${entry.tag}.sql is present`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const description of passes) {
|
||||||
|
console.log(`ok ${description}`);
|
||||||
|
}
|
||||||
|
for (const description of failures) {
|
||||||
|
console.log(`FAIL ${description}`);
|
||||||
|
}
|
||||||
|
if (failures.length > 0) {
|
||||||
|
console.error(`validate: ${failures.length} check(s) failed.`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
console.log(`validate: ${manifest.id}@${manifest.version} passed ${passes.length} checks.`);
|
||||||
@@ -177,10 +177,11 @@ export async function processSignageImage(bytes: Uint8Array): Promise<SignagePro
|
|||||||
height: metadata.height as number,
|
height: metadata.height as number,
|
||||||
width: metadata.width as number,
|
width: metadata.width as number,
|
||||||
};
|
};
|
||||||
const [display, thumbnail] = await Promise.all([
|
// Keep peak native CPU and memory bounded inside the shared API process. Upload concurrency is
|
||||||
renderRendition(bytes, SIGNAGE_IMAGE_DISPLAY_RENDITION),
|
// already bounded at the module UI; running both renditions for every upload in parallel would
|
||||||
renderRendition(bytes, SIGNAGE_IMAGE_THUMBNAIL_RENDITION),
|
// multiply that concurrency again and can starve the database and storage clients on a small host.
|
||||||
]);
|
const display = await renderRendition(bytes, SIGNAGE_IMAGE_DISPLAY_RENDITION);
|
||||||
|
const thumbnail = await renderRendition(bytes, SIGNAGE_IMAGE_THUMBNAIL_RENDITION);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
byteSize: bytes.byteLength,
|
byteSize: bytes.byteLength,
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
import { randomUUID } from "node:crypto";
|
import { randomUUID } from "node:crypto";
|
||||||
import {
|
import {
|
||||||
|
MODULE_STORAGE_ERROR_CODES,
|
||||||
type ModuleStorage,
|
type ModuleStorage,
|
||||||
type ModuleStorageBucket,
|
type ModuleStorageBucket,
|
||||||
ModuleStorageError,
|
type ModuleStorageErrorCode,
|
||||||
} from "@ekklesia/module-sdk";
|
} from "@ekklesia/module-sdk";
|
||||||
import { SignageError } from "../errors.js";
|
import { SignageError } from "../errors.js";
|
||||||
import { type SignageStore, SignageStoreConflict, type StoredImage } from "../store/types.js";
|
import { type SignageStore, SignageStoreConflict, type StoredImage } from "../store/types.js";
|
||||||
@@ -17,6 +18,20 @@ export function nativeImageBucket(storage: ModuleStorage): ModuleStorageBucket {
|
|||||||
return storage.bucket(SIGNAGE_IMAGE_BUCKET);
|
return storage.bucket(SIGNAGE_IMAGE_BUCKET);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Host errors cross the installed-package boundary from a different copy of the SDK, so class
|
||||||
|
* identity is not part of the contract (ADR 0049). Recognize only the SDK's closed, sanitized
|
||||||
|
* storage-error shape; provider messages and causes remain inaccessible. */
|
||||||
|
function storageErrorCode(error: unknown): ModuleStorageErrorCode | undefined {
|
||||||
|
if (!(error instanceof Error) || error.name !== "ModuleStorageError") {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
const code = (error as { readonly code?: unknown }).code;
|
||||||
|
return typeof code === "string" &&
|
||||||
|
(MODULE_STORAGE_ERROR_CODES as readonly string[]).includes(code)
|
||||||
|
? (code as ModuleStorageErrorCode)
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Object keys are scoped to the asset they belong to.
|
* Object keys are scoped to the asset they belong to.
|
||||||
*
|
*
|
||||||
@@ -41,7 +56,7 @@ export function renditionObjectKey(assetId: string, kind: string): string {
|
|||||||
* not a caller's business.
|
* not a caller's business.
|
||||||
*/
|
*/
|
||||||
function storageFailure(error: unknown): SignageError {
|
function storageFailure(error: unknown): SignageError {
|
||||||
if (error instanceof ModuleStorageError && error.code === "STORAGE_OBJECT_NOT_FOUND") {
|
if (storageErrorCode(error) === "STORAGE_OBJECT_NOT_FOUND") {
|
||||||
return new SignageError("SIGNAGE_NOT_FOUND");
|
return new SignageError("SIGNAGE_NOT_FOUND");
|
||||||
}
|
}
|
||||||
return new SignageError("SIGNAGE_STORAGE_UNAVAILABLE");
|
return new SignageError("SIGNAGE_STORAGE_UNAVAILABLE");
|
||||||
@@ -150,7 +165,7 @@ export async function ingestNativeImage(
|
|||||||
if (error instanceof SignageError) {
|
if (error instanceof SignageError) {
|
||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
if (error instanceof ModuleStorageError) {
|
if (storageErrorCode(error) !== undefined) {
|
||||||
throw storageFailure(error);
|
throw storageFailure(error);
|
||||||
}
|
}
|
||||||
throw new SignageError("SIGNAGE_OPERATION_FAILED");
|
throw new SignageError("SIGNAGE_OPERATION_FAILED");
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import type { ModuleStorage } from "@ekklesia/module-sdk";
|
||||||
import sharp from "sharp";
|
import sharp from "sharp";
|
||||||
import { beforeEach, describe, expect, it } from "vitest";
|
import { beforeEach, describe, expect, it } from "vitest";
|
||||||
import { SignageError } from "../src/server/errors.js";
|
import { SignageError } from "../src/server/errors.js";
|
||||||
@@ -372,6 +373,30 @@ describe("native image ingest", () => {
|
|||||||
expect(store.images.size).toBe(0);
|
expect(store.images.size).toBe(0);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("recognizes a sanitized storage failure from the host's separate SDK copy", async () => {
|
||||||
|
const bucket = storage.bucket("native-images");
|
||||||
|
const externalError = Object.assign(new Error("The storage service could not be reached."), {
|
||||||
|
code: "STORAGE_PROVIDER_UNAVAILABLE",
|
||||||
|
name: "ModuleStorageError",
|
||||||
|
});
|
||||||
|
const externalStorage: ModuleStorage = {
|
||||||
|
bucket: () => ({ ...bucket, put: () => Promise.reject(externalError) }),
|
||||||
|
buckets: () => ["native-images"],
|
||||||
|
};
|
||||||
|
|
||||||
|
await expectSignageCode(
|
||||||
|
ingestNativeImage({
|
||||||
|
bytes: await makeImage({ format: "png", height: 360, width: 640 }),
|
||||||
|
displayName: "welcome.png",
|
||||||
|
expiresAt: null,
|
||||||
|
filename: "welcome.png",
|
||||||
|
storage: externalStorage,
|
||||||
|
store,
|
||||||
|
}),
|
||||||
|
"SIGNAGE_STORAGE_UNAVAILABLE",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
it("treats a race with an identical upload as a success rather than a failure", async () => {
|
it("treats a race with an identical upload as a success rather than a failure", async () => {
|
||||||
const bytes = await makeImage({ format: "png", height: 1080, width: 1920 });
|
const bytes = await makeImage({ format: "png", height: 1080, width: 1920 });
|
||||||
const first = await ingest(bytes);
|
const first = await ingest(bytes);
|
||||||
|
|||||||
+3
-3
@@ -3,9 +3,9 @@ import { defineConfig } from "vitest/config";
|
|||||||
/**
|
/**
|
||||||
* Signage's own test configuration.
|
* Signage's own test configuration.
|
||||||
*
|
*
|
||||||
* It exists because this module's browser tests are `.tsx` — they mount real React — and the
|
* It names both `.test.ts` and `.test.tsx` explicitly, because this module's browser tests are `.tsx`
|
||||||
* repository root's configuration includes only `.test.ts`. Without this file those tests are
|
* — they mount real React — and a test that is silently not run is the worst possible failure mode
|
||||||
* silently not run, which is the worst possible failure mode for a test suite.
|
* for a test suite. An empty run fails rather than passes.
|
||||||
*/
|
*/
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
test: {
|
test: {
|
||||||
|
|||||||
Reference in New Issue
Block a user