Index created with blank space on name/field leading/trailing character is not properly shown on Collection / Indexes

XMLWordPrintableJSON

    • Type: Bug
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • Environment:
      OS: MacOS
      node.js / npm versions: N/A
      Additional info:
      Compass latest release 1.50
    • 2
    • None
    • None
    • Developer Tools

      Problem Statement/Rationale

      What is going wrong? What action would you like the Engineering team to take?

      When customers create index(es) with leading or trailing blank space characters, the UI screen "Collection -> Indexes" not properly display the index definition. Both the index name and also the down arrow shows no blank spaces. This is leading to customer confusion to properly:

      • identify the reason why an index is not being utilized
      • index is created but never used

      Important note: This is also impacting MongoDB Atlas Data Explorer UI. Under Atlas, this leads to additional consequences:

      • The recommended index is never removed from Performance Advisor -> Create Indexes
      • Customer slow running operation keeps visible as "COLLSCAN"

      Reference cases
      I could see that multiple customer cases are associated / correlated to this, and it was never fixed up to this moment. Examples:

      • UI invisibility is the common thread: In nearly all cases (01407238, 01402235, 00917897, 00754701, and our 01615166), the whitespace was invisible in the UI (Atlas Data Explorer, Compass, or both). Customers only discovered it via getIndexes() in the shell or third-party tools like NoSQLBooster.
      • Both leading AND trailing spaces: The issue manifests with spaces at either end of the field name. Our case (01615166) has a leading space; 01402235 and 00782584 had trailing spaces. The mechanism is identical.
      • HELP-33193 and PRODTRIAGE-2644 (from case 00917897) are the closest existing Jira tickets: they address the Atlas UI failing to properly handle index names with leading spaces. However, no COMPASS-project Jira ticket exists for the Compass-specific display issue reported in our case.

      Please be sure to attach relevant logs with any sensitive data redacted.
      How to retrieve logs for: Compass; Shell

      N/A

      Steps to Reproduce

      How could an engineer replicate the issue you’re reporting?

      On a MongoDB cluster, create an index for inexistent field name. Adding a blank space on index name is also triggering this. Examples:

      • db.listingsAndReviews.createIndex( {" payback_id":1}

        ,

        {name:" payback_id_1"}

        )

      • db.listingsAndReviews.createIndex( {"payback_id ":1}

        ,

        {name:"payback_id_1 "}

        )

      Expected Results

      What do you expect to happen?

      A visual representation (for example: double quoted and displaying the blank spaces) would be much more effective for our customers to identify similar issues.

      Actual Results

      What do you observe is happening?

      When both above indexes are created their visual representation on Collection / Indexes is exactly the same. Without any blank spaces. They are in fact visually identical (like the indexes were duplicated). I have attached the evidence from UI.

      Additional Notes

      Any additional information that may be useful to include.

            Assignee:
            Unassigned
            Reporter:
            Alex Marini
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: