chore: use erasable syntax #1175

gagik · 2025-11-04T10:24:51Z

With mongodb-js/mongosh#2601 and mongodb-js/compass#7613, this should leave devtools-shared and MCP as last bastions of non-erasable syntax in our products 😄

I admit this went out of hand, originally I thought erasable syntax will be just a couple of enums being converted to consts.
Then I noticed we use a lot of enums.
Then I noticed half of scripts use CJS-specific things.
Then I realized configuring mocha properly to use this erasable syntax is too complicated... so we still use ts-node for that, a shame 😢
Still, having less ts-node is cool. 🤷

Copilot

Pull Request Overview

This PR disables the experimental strip types feature in Node.js to fix failing tests. The change adds the --no-experimental-strip-types flag to the test-webview script while also adding new MongoDB syntax highlighting for similarity operators ($similarityCosine, $similarityDotProduct, $similarityEuclidean) and the $scoreFusion operator.

Disables experimental strip types feature for webview tests
Adds syntax highlighting support for MongoDB similarity operators
Adds syntax highlighting support for MongoDB $scoreFusion operator

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
package.json	Adds `--no-experimental-strip-types` flag to test-webview script to disable the experimental feature
syntaxes/mongodbInjection.tmLanguage.json	Adds TextMate grammar rules for MongoDB similarity operators and score fusion operator

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

syntaxes/mongodbInjection.tmLanguage.json

gagik · 2025-12-03T16:08:15Z

I'll get rid of the workaround after pnpm PR is merged

scripts/generate-icon-font.ts

nbbeeken · 2025-12-12T15:27:16Z

src/documentSource.ts

+export const DOCUMENT_SOURCE = {
+  DOCUMENT_SOURCE_TREEVIEW: 'treeview',
+  DOCUMENT_SOURCE_PLAYGROUND: 'playground',
+  DOCUMENT_SOURCE_COLLECTIONVIEW: 'collectionview',
+  DOCUMENT_SOURCE_CODELENS: 'codelens',
+} as const;
+
+export type DocumentSource =
+  (typeof DOCUMENT_SOURCE)[keyof typeof DOCUMENT_SOURCE];


Suggested change

export const DOCUMENT_SOURCE = {

DOCUMENT_SOURCE_TREEVIEW: 'treeview',

DOCUMENT_SOURCE_PLAYGROUND: 'playground',

DOCUMENT_SOURCE_COLLECTIONVIEW: 'collectionview',

DOCUMENT_SOURCE_CODELENS: 'codelens',

} as const;

export type DocumentSource =

(typeof DOCUMENT_SOURCE)[keyof typeof DOCUMENT_SOURCE];

export const DocumentSource = {

DOCUMENT_SOURCE_TREEVIEW: 'treeview',

DOCUMENT_SOURCE_PLAYGROUND: 'playground',

DOCUMENT_SOURCE_COLLECTIONVIEW: 'collectionview',

DOCUMENT_SOURCE_CODELENS: 'codelens',

} as const;

export type DocumentSource =

(typeof DocumentSource)[keyof typeof DocumentSource];

Then we don't have as many code changes where this is used? it's also kinda convenient if we stick with """enums""" and their type being named the same thing

oh amazing, didn't realize this is possible

nbbeeken · 2025-12-12T15:28:32Z

src/explorer/documentListTreeItem.ts

-  view = 'view',
-  timeseries = 'timeseries',
-}
+export const COLLECTION_TYPES = {


same idea, keep the name and type the same. I won't comment on the rest we can just discuss on my DocumentSource comment

addaleax

Looks good, although I'd love to see @nbbeeken's suggestion of using the fact that types and variables are separate namespaces and we can just align them

gagik · 2025-12-12T16:10:40Z

so... I did do the change but I figured I should also use this as an opportunity to make the naming more consistent and easier to read. I settled on
<enum type in camelcase, in singular form>.<enum value variant in UPPER_SNAKE_CASE
singular form in particular makes more sense to me, the rest is a bit subjective

nbbeeken

I think maybe a small mistake was made, but approach lgtm, so I'll leave the check ✅

nbbeeken · 2025-12-12T17:38:59Z

src/documentSource.ts

-  DOCUMENT_SOURCE_CODELENS = 'codelens',
-}
+export const DocumentSource = {
+  DocumentSource_TREEVIEW: 'treeview',


enum value variant in UPPER_SNAKE_CASE

Was this a search and replace mistake? cus wouldn't this be DOCUMENT_SOURCE_TREEVIEW?

🙈 too much regex for a friday evening

nbbeeken · 2025-12-12T17:40:25Z

src/documentSource.ts

+  DocumentSource_TREEVIEW: 'treeview',
+  DocumentSource_PLAYGROUND: 'playground',
+  DocumentSource_COLLECTIONVIEW: 'collectionview',
+  DocumentSource_CODELENS: 'codelens',


Suggested change

DocumentSource_CODELENS: 'codelens',

codelens: 'codelens',

If you are workshopping patterns it is also kind nice when the key and the value are identical. of course not always possible and I lean more towards less code changes than more when we just want to migrate off the code gen stuff.

your upper snake case pattern is just as good, only sharing opinions here.

cleaned up the stutter here; I'd probably also have preferred the casing to not be upper snake case but I'll keep it the way it (largely) was to avoid doing too many mass string replacements

actually managed to do this with a script and that was simple-ish... so we should have consistent naming now

gagik requested a review from a team as a code owner November 4, 2025 10:24

Copilot AI review requested due to automatic review settings November 4, 2025 10:24

Copilot AI reviewed Nov 4, 2025

View reviewed changes

gagik commented Nov 4, 2025

View reviewed changes

syntaxes/mongodbInjection.tmLanguage.json Show resolved Hide resolved

gagik marked this pull request as draft November 4, 2025 10:26

gagik mentioned this pull request Nov 4, 2025

chore(ci): fix vscode test MONGOSH-2422 mongodb-js/mongosh#2564

Merged

gagik changed the title ~~chore: disable experimental strip types to fix tests~~ chore: use erasable syntax Nov 12, 2025

gagik marked this pull request as ready for review November 12, 2025 14:19

gagik marked this pull request as draft November 12, 2025 14:20

gagik mentioned this pull request Dec 1, 2025

chore(typescript): enable erasableSyntaxOnly for the whole repo mongodb-js/mongosh#2601

Merged

gagik marked this pull request as ready for review December 3, 2025 14:10

gagik added the no-title-validation Skips validation of PR titles (conventional commit adherence + JIRA ticket inclusion) label Dec 3, 2025

chore: use erasable syntax

94c7cd2

gagik force-pushed the gagik/fix-tests branch from 8eddeba to 94c7cd2 Compare December 12, 2025 12:39

gagik added 5 commits December 12, 2025 13:45

chore: remove workarounds

78a7d54

chore: use newer Node

b7b0b8d

chore: pnpm

476f7e2

chore: fixup action

867657f

chore: fix lint

959878d

nbbeeken reviewed Dec 12, 2025

View reviewed changes

addaleax approved these changes Dec 12, 2025

View reviewed changes

gagik added 2 commits December 12, 2025 17:03

chore: combine type and definition

2176e4b

chore: messagetypes

0f0c687

chore: bring back typeof

0a7b403

nbbeeken approved these changes Dec 12, 2025

View reviewed changes

gagik added 3 commits December 15, 2025 13:47

DocumentSource_ => DOCUMENT_SOURCE_

81e2048

chore: cleanup inconsistencies

c21158d

chore: get rid of upper snake case

4396b57

gagik merged commit c84482b into main Dec 15, 2025
12 checks passed

gagik deleted the gagik/fix-tests branch December 15, 2025 15:02

chore: use erasable syntax #1175

chore: use erasable syntax #1175

Uh oh!

Conversation

gagik commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

gagik commented Dec 3, 2025

Uh oh!

Uh oh!

nbbeeken Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

gagik Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

nbbeeken Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

gagik commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nbbeeken left a comment

Choose a reason for hiding this comment

Uh oh!

nbbeeken Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

gagik Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

nbbeeken Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

gagik Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

gagik Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gagik commented Nov 4, 2025 •

edited

Loading

gagik commented Dec 12, 2025 •

edited

Loading

gagik Dec 15, 2025 •

edited

Loading