Merge pull request 'Replace the old team draft with the adopted CommunityRule Creative Team Rule' (#108) from adilallo/fix/CR-302-team-rule into main

Reviewed-on: #108
This commit was merged in pull request #108.
This commit is contained in:
an.di committed 2026-11-13 00:01:33 +00:00
commit d3acd9aa9a
10 files changed
+550 -7

No files matched your search

+5
View File
@@ -42,6 +42,10 @@ RUN ./node_modules/.bin/esbuild scripts/send-rule-follow-up.ts \
--bundle --platform=node --format=cjs \ --bundle --platform=node --format=cjs \
--outfile=follow-up-mail.bundle.cjs \ --outfile=follow-up-mail.bundle.cjs \
--external:@prisma/client --external:@prisma/client
RUN ./node_modules/.bin/esbuild scripts/seed-team-rule.ts \
--bundle --platform=node --format=cjs \
--outfile=team-rule.bundle.cjs \
--external:@prisma/client
FROM base AS runner FROM base AS runner
# openssl: Prisma engines. gosu: privilege drop in start.sh after chown. # openssl: Prisma engines. gosu: privilege drop in start.sh after chown.
@@ -58,6 +62,7 @@ COPY --from=builder --chown=node:node /app/.next/static ./.next/static
COPY --from=builder --chown=node:node /app/prisma ./prisma COPY --from=builder --chown=node:node /app/prisma ./prisma
COPY --from=builder --chown=node:node /app/prune-expired.bundle.cjs ./prune-expired.bundle.cjs COPY --from=builder --chown=node:node /app/prune-expired.bundle.cjs ./prune-expired.bundle.cjs
COPY --from=builder --chown=node:node /app/follow-up-mail.bundle.cjs ./follow-up-mail.bundle.cjs COPY --from=builder --chown=node:node /app/follow-up-mail.bundle.cjs ./follow-up-mail.bundle.cjs
COPY --from=builder --chown=node:node /app/team-rule.bundle.cjs ./team-rule.bundle.cjs
# Facet/template seed JSON — NOT under /app/data (localstorage mount overlays that). # Facet/template seed JSON — NOT under /app/data (localstorage mount overlays that).
COPY --from=builder --chown=node:node /app/data ./seed-data COPY --from=builder --chown=node:node /app/data ./seed-data
ENV SEED_DATA_DIR=/app/seed-data ENV SEED_DATA_DIR=/app/seed-data
+4 -3
View File
@@ -321,8 +321,8 @@ the base image's `node` user (uid 1000), installs `gosu` for the
privilege drop, and symlinks `.next/cache → /tmp/next-cache` so privilege drop, and symlinks `.next/cache → /tmp/next-cache` so
Next.js ISR works on Cloudron's read-only rootfs. `start.sh` runs as Next.js ISR works on Cloudron's read-only rootfs. `start.sh` runs as
root to chown `/app/data` (localstorage mount), then drops to root to chown `/app/data` (localstorage mount), then drops to
`node:node`, applies `prisma migrate deploy`, and execs the Next.js `node:node`, applies `prisma migrate deploy`, writes the adopted team
standalone server. Rule, and execs the Next.js standalone server.
### One-time setup (per operator) ### One-time setup (per operator)
@@ -438,7 +438,8 @@ production env vars, and verify the vertical slice before apex cutover
already installed.) Cloudron provisions **postgresql**, **sendmail**, and already installed.) Cloudron provisions **postgresql**, **sendmail**, and
**localstorage** addons from the manifest, pulls the image (no registry **localstorage** addons from the manifest, pulls the image (no registry
credentials needed), and starts the container. `scripts/start.sh` chowns credentials needed), and starts the container. `scripts/start.sh` chowns
`/app/data`, runs `prisma migrate deploy`, then execs the Next.js server. `/app/data`, runs `prisma migrate deploy`, writes the adopted team Rule,
then execs the Next.js server.
4. **Set manual env vars** (Cloudron does not inject these): 4. **Set manual env vars** (Cloudron does not inject these):
```bash ```bash
cloudron env set --app staging.communityrule.info \ cloudron env set --app staging.communityrule.info \
+5 -2
View File
@@ -94,7 +94,8 @@ credentials on the host), restarts the container, and runs
1. `chown`s `/app/data` (localstorage mount), 1. `chown`s `/app/data` (localstorage mount),
2. runs **`prisma migrate deploy`**, 2. runs **`prisma migrate deploy`**,
3. execs the Next.js standalone server. 3. writes the adopted team Rule (document and visibility together),
4. execs the Next.js standalone server.
Watch the app **Logs** tab in the Cloudron dashboard for a clean migration and Watch the app **Logs** tab in the Cloudron dashboard for a clean migration and
`Listening on port 3000`. `Listening on port 3000`.
@@ -121,7 +122,9 @@ deploying a new image. See [`backend-roadmap.md` §8](backend-roadmap.md#8-prism
### 3.4 Seed data (not every deploy) ### 3.4 Seed data (not every deploy)
Template + facet seed (`MethodFacet` rows for create-flow “Recommended” tags) Template + facet seed (`MethodFacet` rows for create-flow “Recommended” tags)
is **not** applied at boot. Run once per environment after first install, or is **not** applied at boot. The adopted team Rule is the exception: container
start writes that one row so the public catalog does not keep the old draft
body. Run the template seed once per environment after first install, or
when recommendations return all-zero scores: when recommendations return all-zero scores:
```bash ```bash
+124
View File
@@ -0,0 +1,124 @@
import type { CreateFlowState } from "../../app/(app)/create/types";
import {
conflictManagementPresetFor,
decisionApproachPresetFor,
} from "./finalReviewChipPresets";
import { buildPublishPayload } from "./buildPublishPayload";
/** Staging still lists the September draft under this title. */
export const TEAM_RULE_DRAFT_TITLE = "The CommunityRule Project";
export const TEAM_RULE_TITLE = "CommunityRule Creative Team";
const TEAM_RULE_SUMMARY =
"We build and maintain CommunityRule for the communities that use it. It is free for every community that wants to write down how it decides.";
/** Core-value catalog ids, Home hero order. */
const TEAM_RULE_VALUE_IDS = [
"transparency",
"forkability",
"documentation",
"maintenance",
"voluntarism",
] as const;
const TEAM_RULE_COMMUNICATION_IDS = [
"github-gitlab",
"matrix-element",
"email-distribution-list",
"how-we-run-meetings",
] as const;
const TEAM_RULE_MEMBERSHIP_IDS = [
"join-by-contributing",
"companions",
] as const;
const TEAM_RULE_DECISION_IDS = [
"consensus-decision-making",
"lazy-consensus",
"do-ocracy",
"changing-this-rule",
] as const;
const TEAM_RULE_CONFLICT_IDS = [
"conflict-ladder",
"hearing-panel",
"restorative-practices",
] as const;
const VALUE_LABELS: Record<(typeof TEAM_RULE_VALUE_IDS)[number], string> = {
transparency: "Transparency",
forkability: "Forkability",
documentation: "Documentation",
maintenance: "Maintenance",
voluntarism: "Voluntarism",
};
function decisionDetailsFor(
id: (typeof TEAM_RULE_DECISION_IDS)[number],
): NonNullable<CreateFlowState["decisionApproachDetailsById"]>[string] {
const preset = decisionApproachPresetFor(id);
return {
...preset,
selectedApplicableScope: [...preset.applicableScope],
};
}
function conflictDetailsFor(
id: (typeof TEAM_RULE_CONFLICT_IDS)[number],
): NonNullable<CreateFlowState["conflictManagementDetailsById"]>[string] {
const preset = conflictManagementPresetFor(id);
return {
...preset,
selectedApplicableScope: [...preset.applicableScope],
};
}
/** Create-flow state that publishes as the team's adopted Rule. */
function teamRuleCreateFlowState(): CreateFlowState {
return {
title: TEAM_RULE_TITLE,
summary: TEAM_RULE_SUMMARY,
communityContext: TEAM_RULE_SUMMARY,
selectedCoreValueIds: [...TEAM_RULE_VALUE_IDS],
coreValuesChipsSnapshot: TEAM_RULE_VALUE_IDS.map((id) => ({
id,
label: VALUE_LABELS[id],
state: "selected",
})),
selectedCommunicationMethodIds: [...TEAM_RULE_COMMUNICATION_IDS],
selectedMembershipMethodIds: [...TEAM_RULE_MEMBERSHIP_IDS],
selectedDecisionApproachIds: [...TEAM_RULE_DECISION_IDS],
selectedConflictManagementIds: [...TEAM_RULE_CONFLICT_IDS],
decisionApproachDetailsById: Object.fromEntries(
TEAM_RULE_DECISION_IDS.map((id) => [id, decisionDetailsFor(id)]),
),
conflictManagementDetailsById: Object.fromEntries(
TEAM_RULE_CONFLICT_IDS.map((id) => [id, conflictDetailsFor(id)]),
),
};
}
export type AdoptedTeamRule = {
title: string;
summary: string;
document: Record<string, unknown>;
};
/**
* Title, summary, and document for the Rule the team adopted on 30 Oct.
* Card set matches the Home hero; method bodies are the remade-deck presets
* those chips carry.
*/
export function buildAdoptedTeamRule(): AdoptedTeamRule {
const result = buildPublishPayload(teamRuleCreateFlowState());
if (result.ok === false) {
throw new Error(`Failed to build the adopted team Rule: ${result.error}`);
}
return {
title: result.title,
summary: result.summary ?? TEAM_RULE_SUMMARY,
document: result.document,
};
}
+7
View File
@@ -1,5 +1,6 @@
import { PrismaClient, type Prisma } from "@prisma/client"; import { PrismaClient, type Prisma } from "@prisma/client";
import { seedMethodFacets } from "./seed/methodFacets"; import { seedMethodFacets } from "./seed/methodFacets";
import { seedTeamRule } from "./seed/teamRule";
import { seedTemplateFacets } from "./seed/templateFacets"; import { seedTemplateFacets } from "./seed/templateFacets";
/** /**
@@ -402,6 +403,12 @@ async function main() {
console.log( console.log(
`Seeded TemplateFacet rows: ${templateFacetSeed.rowCount}`, `Seeded TemplateFacet rows: ${templateFacetSeed.rowCount}`,
); );
const teamRuleSeed = await seedTeamRule(prisma);
// eslint-disable-next-line no-console -- seed CLI feedback
console.log(
`Seeded team Rule: ${teamRuleSeed.action} ${teamRuleSeed.title} (${teamRuleSeed.id})`,
);
} }
main() main()
+101
View File
@@ -0,0 +1,101 @@
import { isDeepStrictEqual } from "node:util";
import type { Prisma, PrismaClient } from "@prisma/client";
import { publishedRuleAnalyticsFromDocument } from "../../lib/create/publishedRuleAnalytics";
import {
TEAM_RULE_DRAFT_TITLE,
TEAM_RULE_TITLE,
buildAdoptedTeamRule,
} from "../../lib/create/teamRule";
import { RULE_VISIBILITY } from "../../lib/ruleVisibility";
export type SeedTeamRuleResult = {
action: "created" | "updated" | "unchanged";
id: string;
title: string;
};
/**
* Replaces the old "The CommunityRule Project" draft with the adopted Rule,
* or inserts it when the environment has neither row.
* Any other featured row with either title is taken out of the catalog so
* a second copy cannot stay public with a stale document.
*/
export async function seedTeamRule(
prisma: PrismaClient,
): Promise<SeedTeamRuleResult> {
const adopted = buildAdoptedTeamRule();
const document = adopted.document as Prisma.InputJsonValue;
const analytics = publishedRuleAnalyticsFromDocument(adopted.document);
const data = {
title: adopted.title,
summary: adopted.summary,
document,
visibility: RULE_VISIBILITY.public_and_featured,
communityLocation: analytics.communityLocation,
orgType: analytics.orgType,
};
const rows = await prisma.publishedRule.findMany({
where: {
title: { in: [TEAM_RULE_DRAFT_TITLE, TEAM_RULE_TITLE] },
},
orderBy: { createdAt: "asc" },
select: {
id: true,
title: true,
summary: true,
document: true,
visibility: true,
communityLocation: true,
orgType: true,
},
});
const canonical =
rows.find((row) => row.title === TEAM_RULE_DRAFT_TITLE) ?? rows[0];
if (!canonical) {
const row = await prisma.publishedRule.create({
data: {
userId: null,
...data,
},
select: { id: true, title: true },
});
return { action: "created", id: row.id, title: row.title };
}
const matches =
canonical.title === data.title &&
canonical.summary === data.summary &&
canonical.visibility === data.visibility &&
canonical.communityLocation === data.communityLocation &&
canonical.orgType === data.orgType &&
isDeepStrictEqual(canonical.document, data.document);
let action: SeedTeamRuleResult["action"] = "unchanged";
if (!matches) {
await prisma.publishedRule.update({
where: { id: canonical.id },
data,
});
action = "updated";
}
const extraIds = rows
.filter(
(row) =>
row.id !== canonical.id &&
row.visibility === RULE_VISIBILITY.public_and_featured,
)
.map((row) => row.id);
if (extraIds.length > 0) {
await prisma.publishedRule.updateMany({
where: { id: { in: extraIds } },
data: { visibility: RULE_VISIBILITY.private },
});
action = "updated";
}
return { action, id: canonical.id, title: data.title };
}
+28
View File
@@ -0,0 +1,28 @@
/**
* Writes the adopted team Rule, including its document, before the server
* listens. Container start runs the esbuild bundle of this file.
*
* Local:
* node --env-file=.env --import tsx scripts/seed-team-rule.ts
*/
import { PrismaClient } from "@prisma/client";
import { seedTeamRule } from "../prisma/seed/teamRule";
const prisma = new PrismaClient();
async function main() {
const result = await seedTeamRule(prisma);
// eslint-disable-next-line no-console -- boot CLI feedback
console.log(
`Seeded team Rule: ${result.action} ${result.title} (${result.id})`,
);
}
main()
.catch((error) => {
console.error(error);
process.exit(1);
})
.finally(async () => {
await prisma.$disconnect();
});
+3 -2
View File
@@ -18,7 +18,8 @@ chown -R node:node /app/data
mkdir -p /tmp/next-cache mkdir -p /tmp/next-cache
chown -R node:node /tmp/next-cache chown -R node:node /tmp/next-cache
# Drop privileges, apply any pending migrations, then exec the server. # Drop privileges, apply any pending migrations, write the adopted team Rule
# (document included) before anything listens, then exec the server.
# Inner `exec` ensures SIGTERM from Cloudron reaches node for clean shutdown. # Inner `exec` ensures SIGTERM from Cloudron reaches node for clean shutdown.
exec gosu node:node sh -c \ exec gosu node:node sh -c \
'prisma migrate deploy && exec node server.js' 'prisma migrate deploy && node team-rule.bundle.cjs && exec node server.js'
+184
View File
@@ -0,0 +1,184 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
import { publishedRuleAnalyticsFromDocument } from "../../lib/create/publishedRuleAnalytics";
import {
TEAM_RULE_DRAFT_TITLE,
TEAM_RULE_TITLE,
buildAdoptedTeamRule,
} from "../../lib/create/teamRule";
import { RULE_VISIBILITY } from "../../lib/ruleVisibility";
const findManyMock = vi.fn();
const updateMock = vi.fn();
const updateManyMock = vi.fn();
const createMock = vi.fn();
import { seedTeamRule } from "../../prisma/seed/teamRule";
function prismaStub() {
return {
publishedRule: {
findMany: findManyMock,
update: updateMock,
updateMany: updateManyMock,
create: createMock,
},
};
}
function staleRow(
id: string,
title: string,
visibility: string = RULE_VISIBILITY.private,
) {
return {
id,
title,
summary: "September draft",
document: { stale: true },
visibility,
communityLocation: null,
orgType: null,
};
}
beforeEach(() => {
findManyMock.mockReset();
updateMock.mockReset();
updateManyMock.mockReset();
createMock.mockReset();
updateMock.mockResolvedValue({});
updateManyMock.mockResolvedValue({ count: 1 });
});
describe("seedTeamRule", () => {
it("replaces the old draft row in place, including the document", async () => {
const adopted = buildAdoptedTeamRule();
findManyMock.mockResolvedValueOnce([
staleRow("draft-1", TEAM_RULE_DRAFT_TITLE),
]);
const result = await seedTeamRule(prismaStub() as never);
expect(result).toEqual({
action: "updated",
id: "draft-1",
title: TEAM_RULE_TITLE,
});
expect(findManyMock).toHaveBeenCalledWith({
where: {
title: { in: [TEAM_RULE_DRAFT_TITLE, TEAM_RULE_TITLE] },
},
orderBy: { createdAt: "asc" },
select: {
id: true,
title: true,
summary: true,
document: true,
visibility: true,
communityLocation: true,
orgType: true,
},
});
expect(updateMock).toHaveBeenCalledWith({
where: { id: "draft-1" },
data: {
title: adopted.title,
summary: adopted.summary,
document: adopted.document,
visibility: RULE_VISIBILITY.public_and_featured,
...publishedRuleAnalyticsFromDocument(adopted.document),
},
});
expect(updateManyMock).not.toHaveBeenCalled();
expect(createMock).not.toHaveBeenCalled();
});
it("updates an already-renamed adopted row", async () => {
findManyMock.mockResolvedValueOnce([
staleRow("adopted-1", TEAM_RULE_TITLE),
]);
const result = await seedTeamRule(prismaStub() as never);
expect(result.action).toBe("updated");
expect(updateMock).toHaveBeenCalledWith(
expect.objectContaining({ where: { id: "adopted-1" } }),
);
});
it("creates the adopted Rule when neither row exists", async () => {
const adopted = buildAdoptedTeamRule();
findManyMock.mockResolvedValueOnce([]);
createMock.mockResolvedValueOnce({
id: "new-1",
title: TEAM_RULE_TITLE,
});
const result = await seedTeamRule(prismaStub() as never);
expect(result).toEqual({
action: "created",
id: "new-1",
title: TEAM_RULE_TITLE,
});
expect(createMock).toHaveBeenCalledWith({
data: {
userId: null,
title: adopted.title,
summary: adopted.summary,
document: adopted.document,
visibility: RULE_VISIBILITY.public_and_featured,
...publishedRuleAnalyticsFromDocument(adopted.document),
},
select: { id: true, title: true },
});
});
it("unpublishes a second featured row instead of leaving its document public", async () => {
findManyMock.mockResolvedValueOnce([
staleRow(
"adopted-1",
TEAM_RULE_TITLE,
RULE_VISIBILITY.public_and_featured,
),
staleRow("draft-1", TEAM_RULE_DRAFT_TITLE),
]);
const result = await seedTeamRule(prismaStub() as never);
expect(result).toEqual({
action: "updated",
id: "draft-1",
title: TEAM_RULE_TITLE,
});
expect(updateMock).toHaveBeenCalledWith(
expect.objectContaining({ where: { id: "draft-1" } }),
);
expect(updateManyMock).toHaveBeenCalledWith({
where: { id: { in: ["adopted-1"] } },
data: { visibility: RULE_VISIBILITY.private },
});
});
it("does not rewrite a row that already matches the adopted Rule", async () => {
const adopted = buildAdoptedTeamRule();
const analytics = publishedRuleAnalyticsFromDocument(adopted.document);
findManyMock.mockResolvedValueOnce([
{
id: "adopted-1",
title: adopted.title,
summary: adopted.summary,
document: adopted.document,
visibility: RULE_VISIBILITY.public_and_featured,
communityLocation: analytics.communityLocation,
orgType: analytics.orgType,
},
]);
const result = await seedTeamRule(prismaStub() as never);
expect(result.action).toBe("unchanged");
expect(updateMock).not.toHaveBeenCalled();
expect(updateManyMock).not.toHaveBeenCalled();
});
});
+89
View File
@@ -0,0 +1,89 @@
import { describe, expect, it } from "vitest";
import { parsePublishedDocumentForCommunityRuleDisplay } from "../../lib/create/publishedDocumentToDisplaySections";
import {
TEAM_RULE_DRAFT_TITLE,
TEAM_RULE_TITLE,
buildAdoptedTeamRule,
} from "../../lib/create/teamRule";
import heroBanner from "../../messages/en/components/heroBanner.json";
function chipTitles(categoryName: string): string[] {
const rule = buildAdoptedTeamRule();
const sections = parsePublishedDocumentForCommunityRuleDisplay(rule.document);
const section = sections.find((row) => row.categoryName === categoryName);
return (section?.entries ?? []).map((entry) => entry.title);
}
describe("adopted team Rule", () => {
it("uses the adopted title and Home hero summary", () => {
const rule = buildAdoptedTeamRule();
expect(rule.title).toBe(TEAM_RULE_TITLE);
expect(rule.title).toBe(heroBanner.ruleCard.title);
expect(rule.summary).toBe(heroBanner.ruleCard.description);
});
it("contains none of the old draft's title or summary", () => {
const serialized = JSON.stringify(buildAdoptedTeamRule());
expect(serialized).not.toContain(TEAM_RULE_DRAFT_TITLE);
expect(serialized).not.toContain(
"a free toolkit for writing down how communities make decisions",
);
expect(serialized).not.toContain("Skill-Based Contribution");
expect(serialized).not.toContain("Conflict Resolution Council");
});
it("publishes the remade-deck cards the Home hero shows", () => {
const rule = buildAdoptedTeamRule();
const values = rule.document.coreValues as Array<{ chipId: string }>;
expect(values.map((row) => row.chipId)).toEqual([
"transparency",
"forkability",
"documentation",
"maintenance",
"voluntarism",
]);
const methods = rule.document.methodSelections as {
communication: Array<{ id: string }>;
membership: Array<{ id: string }>;
decisionApproaches: Array<{ id: string }>;
conflictManagement: Array<{ id: string }>;
};
expect(methods.communication.map((row) => row.id)).toEqual([
"github-gitlab",
"matrix-element",
"email-distribution-list",
"how-we-run-meetings",
]);
expect(methods.membership.map((row) => row.id)).toEqual([
"join-by-contributing",
"companions",
]);
expect(methods.decisionApproaches.map((row) => row.id)).toEqual([
"consensus-decision-making",
"lazy-consensus",
"do-ocracy",
"changing-this-rule",
]);
expect(methods.conflictManagement.map((row) => row.id)).toEqual([
"conflict-ladder",
"hearing-panel",
"restorative-practices",
]);
});
it("displays the Home hero chip labels, using the deck name for Consensus", () => {
const groups = heroBanner.ruleCard.categories;
expect(chipTitles("Values")).toEqual(groups.values.chips);
expect(chipTitles("Communication")).toEqual(groups.communication.chips);
expect(chipTitles("Membership")).toEqual(groups.membership.chips);
expect(chipTitles("Decision-making")).toEqual(
groups.decisionMaking.chips.map((label) =>
label === "Consensus" ? "Consensus decision-making" : label,
),
);
expect(chipTitles("Conflict management")).toEqual(
groups.conflictManagement.chips,
);
});
});