Notice

1#!/usr/bin/env python3
2"""The approved usage-data notice. Text only — no state, no filesystem, no imports
3but textwrap, so legal can review this file without reading any logic.
4
5Do not rephrase, reorder or trim NOTICE_BODY. Line breaks are the only formatting
6liberty, and they are applied at print time rather than written here.
7"""
8
9import textwrap
10
11NOTICE_TITLE = "AWS Startup Advisor plugin — usage data notice"
12
13# Raise when NOTICE_BODY discloses something new. The record keeps the version a user
14# answered, so data the older notice did not name is not sent on their old answer.
15NOTICE_VERSION = 2
16
17# One unwrapped paragraph; render() wraps it. Do not wrap it here: {opt_out} is
18# substituted before wrapping, so a line that fits in this source need not fit in
19# the output.
20NOTICE_BODY = (
21    "You've installed the AWS Startup Advisor plugin, which provides skills that "
22    "help you build on AWS through your AI coding agent. To help us improve it, "
23    "we'd like to collect optional usage data about how the plugin is used. What "
24    "we collect: which skill you invoked, the plugin version, the host tool "
25    "you're using, a randomly generated install identifier, and, for migration "
26    "skills, the source cloud provider and which migration phase you start and "
27    "complete, and, for operate-on-aws, the ID of the AWS DevOps Agent Space it "
28    "creates. The usage data above is not linked to your identity. You can "
29    "opt-out by {opt_out}. Opting out does not change any plugin functionality."
30)
31
32# The approved source ends in "[Acknowledge]", a GUI button label. In a terminal
33# that renders as a dead string asking the user nothing, so it becomes a question
34# they can answer in words.
35ACKNOWLEDGE_PROMPT = (
36    'Do you acknowledge this notice? Reply "yes" to acknowledge, or "opt out" if '
37    "you would rather no usage data was collected. Either answer is fine, and "
38    "nothing is collected until you answer."
39)
40
41# TODO(StartupEngBlend-3621): confirm both substitutions with legal.
42
43# 79, not 80, so a terminal reserving a cell for the cursor does not re-wrap.
44WRAP_WIDTH = 79
45
46
47def _wrap(text):
48    # break_* off so a path or variable name is never split across lines.
49    return textwrap.fill(
50        text,
51        width=WRAP_WIDTH,
52        break_long_words=False,
53        break_on_hyphens=False,
54    )
55
56
57def render(opt_out):
58    """The notice as the user must see it.
59
60    `opt_out` completes "You can opt-out by ...". Substitute first, then wrap.
61    """
62    body = _wrap(NOTICE_BODY.format(opt_out=opt_out))
63    return "%s\n\n%s\n\n%s\n" % (NOTICE_TITLE, body, _wrap(ACKNOWLEDGE_PROMPT))