Skip to content

docs: say that the default questions read the visitor salt - #93

Merged
hughgrigg merged 1 commit into
mainfrom
docs/visitor-salt-in-default-deployments
Aug 28, 2026
Merged

docs: say that the default questions read the visitor salt#93
hughgrigg merged 1 commit into
mainfrom
docs/visitor-salt-in-default-deployments

Conversation

@hughgrigg

Copy link
Copy Markdown
Contributor

The prop doc on visitorSaltParameter said that a deployment whose questions count no visitors never reads it and none has to exist. That is true, and it describes a case the defaults fall outside. pageviews counts visitors, and it is one of the five questions a deployment that passes no rollups gets. The parameter is therefore a prerequisite of a default deploy, and a stack that goes up without one loses both pageviews schedules on their first call while the other four questions keep computing. The prop now says that the default questions read it, that it has to exist before the first run, and that a deployment wanting none passes rollups without a question that counts visitors. docs/summary-schedule/ says the same under the props table, next to what the permissions section already says about ssm:GetParameter reading a parameter no template creates. docs/visitors/ held the two halves of this in separate sections, and "Which questions carry a count" now carries both. The thinner copy of the doc on SummaryFunctionProps is left alone, since that construct is not exported, never sees the rollups list, and takes the parameter from whatever chose the questions. One change here is unrelated to the issue. #89 removed the viewsOnly constant from rollup-summaries.test.ts while #91 added a use of it, and main has not compiled since the two merged, with pnpm check failing in tsc before it reaches a test. That case synthesises a stack and runs no query, and it takes pageviews like the deployment case above it.

Resolves #87

  • Conventional commit message, used as the title

  • Conventional branch name, like feat/concise-description

  • Full check with pnpm run check passed

  • Rebased off latest main

  • User-facing behaviour is documented in docs/

See https://www.conventionalcommits.org/en/v1.0.0/

The prop doc on `visitorSaltParameter` said that a deployment whose
questions count no visitors never reads it and none has to exist. That is
true, and it describes a case the defaults fall outside. `pageviews`
counts visitors, and it is one of the five questions a deployment that
passes no `rollups` gets. The prop, the props table in
`docs/summary-schedule/` and "Which questions carry a count" in
`docs/visitors/` now say that a default deployment reads the parameter,
that it has to exist before the first run, and that a deployment wanting
none passes `rollups` without a question that counts visitors.

`rollup-summaries.test.ts` also loses a reference to a constant that no
longer exists. #89 removed `viewsOnly` while #91 added a use of it, and
main has not compiled since the two merged.
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 15 minutes.

View limit details

Limit details: You’ve used all 2 included reviews currently available. Your 88 included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: a651e2d7-d0c0-4548-abce-17be79e36296

📥 Commits

Reviewing files that changed from the base of the PR and between 6f22067 and 88fa97b.

📒 Files selected for processing (4)
  • docs/summary-schedule/README.md
  • docs/visitors/README.md
  • src/cdk/rollup-summaries.test.ts
  • src/cdk/summary-configuration.ts

Comment @coderabbitai help to get the list of available commands.

@hughgrigg
hughgrigg merged commit 69b1389 into main Aug 28, 2026
7 checks passed
@hughgrigg
hughgrigg deleted the docs/visitor-salt-in-default-deployments branch August 28, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Visitor salt parameter is required by a default RollupSummaries deployment

1 participant