@contractkit/prettier-plugin 0.14.2 → 0.14.4

package/tests/round-trip.test.ts

@@ -1,694 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { readdirSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { printCk } from '../src/print-ck.js';
-import { parseCk, DiagnosticCollector } from '@contractkit/core';
-
-/**
- * Formatting a `.ck` file must not change it.
- *
- * The prettier plugin used to fold standalone `#` comment blocks into trailing comments on the
- * following declaration, reorder operation body keys, drop blank lines between operations, and
- * expand single-line response bodies — all of which silently rewrote a user's file on
- * `pnpm format`. These tests pin the guarantee: parse → print is the identity on well-formed
- * source, and printing is idempotent.
- */
-
-function format(source: string, file = 'test.ck'): string {
-    const diag = new DiagnosticCollector();
-    const ast = parseCk(source, file, diag);
-    expect(diag.hasErrors()).toBe(false);
-    return printCk(ast);
-}
-
-// ─── Repository contracts ────────────────────────────────────────────────────
-
-const CONTRACTS_DIR = new URL('../../../contracts', import.meta.url).pathname;
-const ckFiles = readdirSync(CONTRACTS_DIR).filter(f => f.endsWith('.ck'));
-
-describe('round-trip — repository .ck files', () => {
-    it('finds .ck files to check', () => {
-        expect(ckFiles.length).toBeGreaterThan(0);
-    });
-
-    for (const name of ckFiles) {
-        it(`formats ${name} to itself`, () => {
-            const source = readFileSync(join(CONTRACTS_DIR, name), 'utf8');
-            expect(format(source, name)).toBe(source);
-        });
-    }
-});
-
-// ─── Constructs that previously round-tripped lossily ────────────────────────
-
-describe('round-trip — comment placement', () => {
-    it('keeps a standalone comment block above the declaration it precedes', () => {
-        const source = `# ─── Pet endpoints ───
-
-operation /pet: {
-    get: {
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a contract doc comment on its own line', () => {
-        const source = `# A pet for sale
-contract Pet: {
-    id: int
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a contract doc comment inline when written inline', () => {
-        const source = `contract Pet: { # A pet for sale
-    id: int
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('distinguishes a divider from the doc comment below it', () => {
-        const source = `# ─── Models ───
-
-# A pet for sale
-contract Pet: {
-    id: int
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an operation doc comment on its own line', () => {
-        const source = `operation /pet: {
-    # update an existing pet
-    put: {
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an operation doc comment inline when written inline', () => {
-        const source = `operation /pet: {
-    put: { # update an existing pet
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-describe('round-trip — comments in the options block', () => {
-    it('keeps a header comment above the options keyword', () => {
-        const source = `# ContractKit contracts for billing.
-# Owned by the payments team.
-options {
-    keys: {
-        area: billing
-    }
-}
-
-contract Pet: {
-    id: uuid
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a trailing comment on an options entry, braces and all', () => {
-        // The value used to swallow the comment and stop at the first `}`, which closed the
-        // block early and silently mis-parsed everything after it.
-        const source = `options {
-    keys: {
-        area: billing # interpolated elsewhere as {{area}}
-    }
-    services: {
-        PetService: "#modules/pet/pet.service.js"
-    }
-}
-
-contract Pet: {
-    id: uuid
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an unquoted subpath value unquoted', () => {
-        // Both forms parse to the same string, so the parser records which one the author wrote;
-        // without that the formatter normalizes every value to the quoted form.
-        const source = `options {
-    services: {
-        PetService: #modules/pet/pet.service.js
-    }
-}
-
-contract Pet: {
-    id: uuid
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a quoted value quoted', () => {
-        const source = `options {
-    services: {
-        PetService: "#modules/pet/pet.service.js"
-    }
-}
-
-contract Pet: {
-    id: uuid
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps both forms side by side, with their comments', () => {
-        const source = `options {
-    services: {
-        Bare: #modules/a/a.service.js # unquoted
-        Quoted: "#modules/b/b.service.js" # quoted
-    }
-}
-
-contract Pet: {
-    id: uuid
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment above a sub-block', () => {
-        const source = `options {
-    # where these come from
-    keys: {
-        area: ledger
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment run above the sub-block it precedes', () => {
-        const source = `options {
-    keys: {
-        area: ledger
-    }
-    # service wiring
-    # one per module
-    services: {
-        UserService: "#src/user.js"
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a trailing comment before the closing brace', () => {
-        const source = `options {
-    keys: {
-        area: ledger
-    }
-    # nothing below
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an options block that holds nothing but a comment', () => {
-        const source = `options {
-    # a note
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-describe('round-trip — operation body key order', () => {
-    it('does not reorder keys into a canonical order', () => {
-        const source = `operation /pet: {
-    put: {
-        sdk: updatePet
-        service: PetService.update
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('preserves the opposite order just as faithfully', () => {
-        const source = `operation /pet: {
-    put: {
-        service: PetService.update
-        sdk: updatePet
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-describe('round-trip — layout', () => {
-    it('keeps blank lines between operations', () => {
-        const source = `operation /pet: {
-    get: {
-        response: {
-            200:
-        }
-    }
-
-    post: {
-        response: {
-            201:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps operations packed when the source has no blank line', () => {
-        const source = `operation /pet: {
-    get: {
-        response: {
-            200:
-        }
-    }
-    post: {
-        response: {
-            201:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a single-line response body on one line', () => {
-        const source = `operation /pet: {
-    get: {
-        response: {
-            200: { application/json: Pet }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an expanded response body expanded', () => {
-        const source = `operation /pet: {
-    get: {
-        response: {
-            200: {
-                application/json: Pet
-            }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an empty status block, which means emitted with no body', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: { application/json: Art }
-            304: {}
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a bare status bare', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: { application/json: Art }
-            304:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps the documented modifier on a status', () => {
-        const source = `operation /pet: {
-    get: {
-        response: {
-            200: { application/json: Pet }
-            404(documented): { application/json: Problem }
-            410(documented):
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps every declared mime for a status, in source order', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: {
-                image/png: binary
-                image/jpeg: binary
-                headers: {
-                    etag?: string
-                }
-            }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps several mimes on one line when the source has them there', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: { image/png: binary image/jpeg: binary }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-// ─── Comments in the response block ──────────────────────────────────────────
-
-describe('round-trip — comments in the response block', () => {
-    it('keeps a comment run above a status code', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            # One declared mime per format, because the router pins ctx.type from this line
-            # and a service cannot vary it per request.
-            200: {
-                image/png: binary
-            }
-            # Produced by the conditional-GET middleware, not by the handler.
-            304:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment above a mime line inside a status block', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: {
-                # served straight from object storage
-                image/png: binary
-            }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment above a headers block', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: {
-                image/png: binary
-                # set by the CDN, echoed here so the SDK types it
-                headers: {
-                    etag?: string
-                }
-            }
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps trailing comments before either closing brace', () => {
-        const source = `operation /art/{id}: {
-    get: {
-        response: {
-            200: {
-                image/png: binary
-                # TODO: add image/avif once the encoder lands
-            }
-            # TODO: document the 429 the rate limiter returns
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-// ─── Security blocks ─────────────────────────────────────────────────────────
-
-/**
- * A `security { }` block is where authors record *why* a policy floor sits where it does, so the
- * prose in and around it is load-bearing. Every position here used to be deleted outright on
- * format: the parser skipped standalone comments inside the block, dropped comment runs above a
- * body key, and let a comment run above a verb lose to the verb's own inline doc comment.
- */
-describe('round-trip — security block comments', () => {
-    it('keeps a comment above the policy line in the options block', () => {
-        const source = `options {
-    security: {
-        # The floor for every operation in this file.
-        # Reads override it downward at their own verb.
-        policy: platform.manage
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment after the policy line, before the closing brace', () => {
-        const source = `options {
-    security: {
-        policy: platform.manage
-        # Object-scoped permissions cannot be named here yet.
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('distinguishes an inline policy comment from one on the next line', () => {
-        const source = `options {
-    security: {
-        # Why this floor
-        policy: platform.manage # the operator gate
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment above a security block inside an operation body', () => {
-        const source = `operation /plugins: {
-    get: {
-        name: List plugins
-        # A read, so it drops to the view floor.
-        security: {
-            policy: platform.view
-        }
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment above a security: none line', () => {
-        const source = `operation /plugins/callback: {
-    get: {
-        name: OAuth callback
-        # The provider redirects a browser here, so it cannot carry a session.
-        security: none
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment run above a verb that also has an inline doc comment', () => {
-        const source = `operation /plugins/{id}/logs: {
-    params: {
-        id: uuid
-    }
-    # Log output is whatever the plugin chose to write, including upstream error
-    # bodies. Treat it as operator-only until the log store can promise otherwise.
-    get: { # Returns the plugin's buffered log lines
-        name: Get plugin logs
-        response: {
-            200:
-        }
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment left after the last key in an operation body', () => {
-        const source = `operation /plugins: {
-    get: {
-        name: List plugins
-        response: {
-            200:
-        }
-        # TODO: gate this behind the object-scoped permission once it exists
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-// ─── Declaration-boundary comments ───────────────────────────────────────────
-
-/**
- * A comment between two top-level declarations is ambiguous: it can be an inline comment trailing
- * the one above, a doc comment for the one below, or a standalone block. A declaration could not
- * see what preceded it, so `ModelBody`'s optional trailing comment claimed the *next* line's
- * comment — deleting a doc comment, or silently re-filing it as the previous contract's
- * description. `Root` places these now, by comparing source lines.
- */
-describe('round-trip — comments between declarations', () => {
-    it('keeps a doc comment on a contract that follows a one-line alias contract', () => {
-        const source = `contract ConfigFieldType: enum(string, url, secret)
-
-# One choice of a \`select\` config field
-contract ConfigFieldOption: {
-    value: string
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an inline comment on an alias contract where it was written', () => {
-        const source = `contract PluginStatus: enum(discovered, active) # Lifecycle state
-
-contract ConfigFieldOption: {
-    value: string
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('tells an inline comment apart from the doc comment below it', () => {
-        const source = `contract PluginStatus: enum(discovered, active) # Lifecycle state
-
-# One choice of a \`select\` config field
-contract ConfigFieldOption: {
-    value: string
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps an inline comment on the last declaration in the file', () => {
-        const source = `contract PluginStatus: enum(discovered, active) # Lifecycle state
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a comment after the last declaration', () => {
-        const source = `contract PluginStatus: enum(discovered, active)
-
-# TODO: add the archived state once the store supports it
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-// ─── Field comments ──────────────────────────────────────────────────────────
-
-describe('round-trip — field comments', () => {
-    it('keeps a comment on a nested inline object opening brace', () => {
-        const source = `contract FidoFactorAttestation: {
-    rp: { # The relying party
-        name: string # The relying party name
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a nested brace comment that repeats the contract header wording', () => {
-        // The header comment is reclaimed from the field list by matching text; when a nested
-        // field carried the same wording, the reclaim deleted the wrong one.
-        const source = `contract FidoFactorAttestation: { # The FIDO factor attestation information
-    rp: { # The FIDO factor attestation information
-        name: string # The relying party name
-    }
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-
-    it('keeps a trailing comment on a field whose enum type wraps', () => {
-        const source = `contract LineupEntry: {
-    segmentState?: enum(
-        planned,
-        rendering,
-        ready,
-        failed,
-        gone
-    ) # How far along the segment is
-}
-`;
-        expect(format(source)).toBe(source);
-    });
-});
-
-// ─── Idempotence ─────────────────────────────────────────────────────────────
-
-describe('round-trip — idempotence', () => {
-    const sources = [
-        ...ckFiles.map(name => readFileSync(join(CONTRACTS_DIR, name), 'utf8')),
-        // Non-canonical spacing: formatting once must reach a fixed point.
-        `operation /pet: {\n    get: {\n        response: {\n            200:\n        }\n    }\n}\n`,
-    ];
-
-    for (const [i, source] of sources.entries()) {
-        it(`formatting is a fixed point for source #${i}`, () => {
-            const once = format(source);
-            expect(format(once)).toBe(once);
-        });
-    }
-});