Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(schema-engine): add support for multiple split schema files #4809

Closed
wants to merge 17 commits into from

Commits on Mar 21, 2024

  1. Implement multi-file schema handling in PSL

    This commit implements multi-file schema handling in the Prisma Schema Language.
    
    At a high level, instead of accepting a single string, `psl::validate_multi_file()` is an alternative to `psl::validate()` that accepts something morally equivalent to:
    
    ```json
    {
      "./prisma/schema/a.prisma": "datasource db { ... }",
      "./prisma/schema/nested/b.prisma": "model Test { ... }"
    }
    ```
    
    There are tests for PSL validation with multiple schema files, but most of the rest of engines still consumes the single file version of `psl::validate()`. The implementation and the return type are shared between `psl::validate_multi_file()` and `psl::validate()`, so the change is completely transparent, other than the expectation of passing in a list of (file_name, file_contents) instead of a single string. The `psl::validate()` entry point should behave exactly the same as `psl::multi_schema()` with a single file named `schema.prisma`. In particular, it has the exact same return type.
    
    Implementation
    ==============
    
    This is achieved by extending `Span` to contain, in addition to a start and end offset, a `FileId`. The `FileId` is a unique identifier for a file and its parsed `SchemaAst` inside `ParserDatabase`. The identifier types for AST items in `ParserDatabase` are also extended to contain the `FileId`, so that they can be uniquely referred to in the context of the (multi-file) schema. After the analysis phase (the `parser_database` crate), consumers of the analyzed schema become multi-file aware completely transparently, no change is necessary in the other engines.
    
    The only changes that will be required at scattered points across the codebase are the `psl::validate()` call sites that will need to receive a `Vec<Box<Path>, SourceFile>` instead of a single `SourceFile`. This PR does _not_ deal with that, but it makes where these call sites are obvious by what entry points they use: `psl::validate()`, `psl::parse_schema()` and the various `*_assert_single()` methods on `ParserDatabase`.
    
    The PR contains tests confirming that schema analysis, validation and displaying diagnostics across multiple files works as expected.
    
    Status of this PR
    =================
    
    This is going to be directly mergeable after review, and it will not affect the current schema handling behaviour when dealing with a single schema file.
    
    Next steps
    ==========
    
    - Replace all calls to `psl::validate()` with calls to `psl::validate_multi_file()`.
    - The `*_assert_single()` calls should be progressively replaced with their multi-file counterparts across engines.
    - The language server should start sending multiple files to prisma-schema-wasm in all calls. This is not in the spirit of the language server spec, but that is the most immediate solution. We'll have to make `range_to_span()` in `prisma-fmt` multi-schema aware by taking a FileId param.
    
    Links
    =====
    
    Relevant issue: prisma/prisma#2377
    
    Also see the [internal design doc](https://www.notion.so/prismaio/Multi-file-Schema-24d68fe8664048ad86252fe446caac24?d=68ef128f25974e619671a9855f65f44d#2889a038e68c4fe1ac9afe3cd34978bd).
    tomhoule authored and SevInf committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    1e42d35 View commit details
    Browse the repository at this point in the history

Commits on Mar 22, 2024

  1. Configuration menu
    Copy the full SHA
    aad9355 View commit details
    Browse the repository at this point in the history

Commits on Mar 26, 2024

  1. Reformat support (psl crate)

    SevInf committed Mar 26, 2024
    Configuration menu
    Copy the full SHA
    0128219 View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. Configuration menu
    Copy the full SHA
    4ff6406 View commit details
    Browse the repository at this point in the history
  2. Clippy

    SevInf committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    ad12e21 View commit details
    Browse the repository at this point in the history

Commits on Apr 4, 2024

  1. Configuration menu
    Copy the full SHA
    11925e2 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    40c7dac View commit details
    Browse the repository at this point in the history
  3. feat(schema-engine): update json-rpc-api-build types to support schem…

    …a split into multiple files
    jkomyno committed Apr 4, 2024
    Configuration menu
    Copy the full SHA
    f499f0f View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    ea3adb0 View commit details
    Browse the repository at this point in the history

Commits on Apr 5, 2024

  1. Configuration menu
    Copy the full SHA
    49e66e0 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    408a77a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    bccfbca View commit details
    Browse the repository at this point in the history

Commits on May 1, 2024

  1. chore: merge main

    jkomyno committed May 1, 2024
    Configuration menu
    Copy the full SHA
    69cb2ab View commit details
    Browse the repository at this point in the history

Commits on May 6, 2024

  1. Configuration menu
    Copy the full SHA
    3360e0e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    75e398c View commit details
    Browse the repository at this point in the history

Commits on May 7, 2024

  1. Configuration menu
    Copy the full SHA
    2d3bc4d View commit details
    Browse the repository at this point in the history

Commits on May 16, 2024

  1. finish cli inputs refactoring

    Weakky committed May 16, 2024
    Configuration menu
    Copy the full SHA
    25f085b View commit details
    Browse the repository at this point in the history