Drop prefixPreview, suffixPreview, and substringPreview APIs

ExportXMLWordPrintableJSON

    • Type: Spec Change
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Component/s: Client Side Encryption
    • Needed
    • Hide

      Summary of necessary driver changes

      • Drop API for (prefix|suffix|substring)Preview.
      • Upgrade to libmongocrypt 1.21.0.
      • Skip or remove "QE-Text-*-Preview" tests.
        • Removing related specification tests (JSON/YAML) is tracked in DRIVERS-3665. This will be done as a follow-up to avoid dropping test coverage drivers that update specification tests without upgrading libmongocrypt.

      Commits for syncing spec/prose tests

      Show
      Summary of necessary driver changes Drop API for (prefix|suffix|substring)Preview. Upgrade to libmongocrypt 1.21.0. MONGOCRYPT-938 makes using preview a runtime error. Skip or remove "QE-Text-*-Preview" tests. Removing related specification tests (JSON/YAML) is tracked in DRIVERS-3665 . This will be done as a follow-up to avoid dropping test coverage drivers that update specification tests without upgrading libmongocrypt. Commits for syncing spec/prose tests   https://github.com/mongodb/specifications/commit/7235b61bde1bc75e51f28d8f67dd935198969c02
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-6376 Fixed 2.6.0
      CXX-3540 Backlog
      CSHARP-6137 In Code Review
      GODRIVER-4047 Ready for Work
      JAVA-6257 In Code Review
      NODE-7698 Ready for Work
      PYTHON-5959 Ready for Work
      PHPLIB-1916 Ready for Work
      RUBY-3919 Fix Not Needed
      RUST-2460 Ready for Work
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } #scriptField td.willNotDo { background-color: #FF0000; /* Red color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-6376 Fixed 2.6.0 CXX-3540 Backlog CSHARP-6137 In Code Review GODRIVER-4047 Ready for Work JAVA-6257 In Code Review NODE-7698 Ready for Work PYTHON-5959 Ready for Work PHPLIB-1916 Ready for Work RUBY-3919 Fix Not Needed RUST-2460 Ready for Work

      Summary

      Drop support for "prefixPreview", "suffixPreview", and "substringPreview". 

      Motivation

      DRIVERS-3321 adds support for "prefix" and "suffix". DRIVERS-3540 intends to add support for "substring".

      DRIVERS-3321 previously proposed dropping "prefixPreview" and "suffixPreview", this was determined to be too-soon (see slack thread). Server 9.0 is not-yet released, so users of preview would lose access.

      Who is the affected end user?

      Users of QE "prefixPreview", "suffixPreview", and "substringPreview".

      How does this affect the end user?

      Dropping preview will require users migrate to the stable "prefix", "suffix", and "substring" and recreate collections on server 9.0.

      How likely is it that this problem or use case will occur?

      Likely? Attempting to use preview on server 9.0 results in a server error:

      Cannot create a collection with an encrypted field with query type prefixPreview, as it is deprecated

      Dropping preview is not strictly needed. Preview can be used on 8.2 and 8.3 servers. Removing preview forces users to migrate to the stable names, and avoids persisting experimental API in drivers.

      If the problem does occur, what are the consequences and how severe are they?

      N/A?

      Is this issue urgent?

      Schedule close to the server 9.0 release to avoid dropping preview too-far in advance of server 9.0.

      Is this ticket required by a downstream team?

      I expect mongosh + Compass.

      Is this ticket only for tests?

      No.

      Acceptance Criteria

      • Drop references to "prefixPreview", "suffixPreview", and "substringPreview" from drivers specifications.

            Assignee:
            Adrian Dole
            Reporter:
            Kevin Albertson
            Kevin Albertson Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: