Configuration

tilttek_generator:
    # Files and directories of YAML and JSON documents; config/generators of the project when it exists and no path
    # is given.
    paths: ['%kernel.project_dir%/config/generators']

    # The language of the generators that do not name theirs.
    locale: en

    # More French words whose h is aspirated, which keep their article whole.
    aspirated: [hobgobelin]

    # More Spanish feminine words whose first syllable is a stressed a, which take el and un.
    stressed_a: [ánima]

    # The bounds that stop a generator gone wild.
    limits:
        depth: 8
        picks: 1000
        milliseconds: 250
        attempts: 10
        results: 100
        cells: 2500
        draw_milliseconds: 1000

    # Keeps Twig's compiled templates in %kernel.cache_dir%/tilttek_generator/twig.
    cache: true

    # Loads the library's random tables too, named table.<name>.
    tables: false

    # The language of the random tables: "en" or "fr".
    tables_locale: en

    # Where the tables with a memory keep their states between draws.
    state:
        # "cache", "memory" for tests, or the service of a store of the application.
        store: cache
        # The PSR-6 cache pool of the "cache" store.
        pool: cache.app
        # The service of a Symfony lock factory that keeps two draws on the same state apart; none by default.
        lock: lock.factory

    # The draw API: off by default; only the generators it names are drawn, never their lists.
    api:
        enabled: false
        # The most results of one draw, within limits.results.
        max_count: 20
        # The generators anyone may draw, without a token.
        public: [name.short]
        # The rate limiter factory service of the public draws, counted by address; the bundle's own when null.
        rate_limiter: limiter.generator_public
        # The default rate limit of the public draws, by address, when no rate limiter is named.
        public_limit: { limit: 60, interval: '1 minute' }
        # The sites and applications that draw with a token, by name.
        clients:
            partner:
                token: '%env(GENERATOR_PARTNER_TOKEN)%'
                # The generators open to the client; "*" opens them all.
                generators: [tavern, name.short]
                rate_limiter: limiter.generator_partner

An API that opens generators to anyone is rate limited by default: without api.rate_limiter, the bundle makes a limiter of api.public_limit with the rate limiter builder of symfony/rate-limiter, sixty draws a minute by address. Without that component, or with framework.rate_limiter disabled, the container is refused with what to do. The time of a whole draw, limits.draw_milliseconds, bounds what one request may cost on top of it.

The rate limiters are those of framework.rate_limiter; a limiter named generator_public is the service limiter.generator_public:

framework:
    rate_limiter:
        generator_public: { policy: sliding_window, limit: 60, interval: '1 minute' }
        generator_partner: { policy: token_bucket, limit: 600, rate: { interval: '1 minute', amount: 600 } }

A pool that keeps the states across deployments, on the application's Doctrine connection:

framework:
    cache:
        pools:
            cache.generator_states:
                adapter: cache.adapter.doctrine_dbal
                default_lifetime: 0

tilttek_generator:
    state: { pool: cache.generator_states }

The catalog is cached in %kernel.cache_dir%/tilttek_generator/catalog.php; in debug, it is written again when a file or a directory of the paths changes, even in the second the cache was written. Out of debug, clear the cache after changing the files.

The generator keeps between requests only the entries of each list filtered by tag, at most 64 filters by list, with what a Markov list learnt from them, and nothing of a draw: it is safe in a worker. The states live in their store, not in a service.