Skip to content

Commit 43f748c

Browse files
nbbeekennbbeeken
authored
chore(NODE-4153): make type fixes for ts 4.7 (#3185)
1 parent 0ed7cbf commit 43f748c

24 files changed

+804
-636
lines changed

‎.evergreen/config.yml‎

Lines changed: 92 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -213,14 +213,60 @@ functions:
213213
NO_EXIT=${NO_EXIT|1} \
214214
LOAD_BALANCER="${LOAD_BALANCER}" \
215215
bash ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
216-
run checks:
217-
- command: shell.exec
218-
type: test
216+
run lint checks:
217+
- command: subprocess.exec
219218
params:
220219
working_dir: src
221-
script: |
222-
${PREPARE_SHELL}
223-
bash ${PROJECT_DIRECTORY}/.evergreen/run-checks.sh
220+
timeout_secs: 60
221+
env:
222+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
223+
binary: bash
224+
args:
225+
- ${PROJECT_DIRECTORY}/.evergreen/run-lint-checks.sh
226+
run unit tests:
227+
- command: subprocess.exec
228+
params:
229+
working_dir: src
230+
timeout_secs: 60
231+
env:
232+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
233+
binary: bash
234+
args:
235+
- ${PROJECT_DIRECTORY}/.evergreen/run-unit-tests.sh
236+
run typescript next:
237+
- command: subprocess.exec
238+
params:
239+
working_dir: src
240+
timeout_secs: 60
241+
env:
242+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
243+
TS_VERSION: next
244+
binary: bash
245+
args:
246+
- ${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh
247+
run typescript oldest:
248+
- command: subprocess.exec
249+
params:
250+
working_dir: src
251+
timeout_secs: 60
252+
env:
253+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
254+
TS_VERSION: 4.1.6
255+
TRY_COMPILING_DRIVER: 'false'
256+
binary: bash
257+
args:
258+
- ${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh
259+
run typescript current:
260+
- command: subprocess.exec
261+
params:
262+
working_dir: src
263+
timeout_secs: 60
264+
env:
265+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
266+
TS_VERSION: ''
267+
binary: bash
268+
args:
269+
- ${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh
224270
run mongosh integration tests:
225271
- command: shell.exec
226272
type: test
@@ -1734,14 +1780,46 @@ tasks:
17341780
- func: add aws auth variables to file
17351781
- func: setup aws env
17361782
- func: run aws ECS auth test
1737-
- name: run-checks
1783+
- name: run-unit-tests
1784+
tags:
1785+
- run-unit-tests
1786+
commands:
1787+
- func: install dependencies
1788+
vars:
1789+
NODE_LTS_NAME: erbium
1790+
- func: run unit tests
1791+
- name: run-lint-checks
1792+
tags:
1793+
- run-lint-checks
1794+
commands:
1795+
- func: install dependencies
1796+
vars:
1797+
NODE_LTS_NAME: erbium
1798+
- func: run lint checks
1799+
- name: run-typescript-next
1800+
tags:
1801+
- run-typescript-next
1802+
commands:
1803+
- func: install dependencies
1804+
vars:
1805+
NODE_LTS_NAME: erbium
1806+
- func: run typescript next
1807+
- name: run-typescript-current
1808+
tags:
1809+
- run-typescript-current
1810+
commands:
1811+
- func: install dependencies
1812+
vars:
1813+
NODE_LTS_NAME: erbium
1814+
- func: run typescript current
1815+
- name: run-typescript-oldest
17381816
tags:
1739-
- run-checks
1817+
- run-typescript-oldest
17401818
commands:
17411819
- func: install dependencies
17421820
vars:
17431821
NODE_LTS_NAME: erbium
1744-
- func: run checks
1822+
- func: run typescript oldest
17451823
- name: run-mongosh-integration-tests
17461824
tags:
17471825
- run-mongosh-integration-tests
@@ -2307,7 +2385,11 @@ buildvariants:
23072385
display_name: lint
23082386
run_on: ubuntu1804-large
23092387
tasks:
2310-
- run-checks
2388+
- run-unit-tests
2389+
- run-lint-checks
2390+
- run-typescript-current
2391+
- run-typescript-oldest
2392+
- run-typescript-next
23112393
- name: mongosh_integration_tests
23122394
display_name: mongosh integration tests
23132395
run_on: ubuntu1804-test

‎.evergreen/config.yml.in‎

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,14 +238,64 @@ functions:
238238
LOAD_BALANCER="${LOAD_BALANCER}" \
239239
bash ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
240240

241-
"run checks":
242-
- command: shell.exec
243-
type: test
241+
"run lint checks":
242+
- command: subprocess.exec
244243
params:
245244
working_dir: "src"
246-
script: |
247-
${PREPARE_SHELL}
248-
bash ${PROJECT_DIRECTORY}/.evergreen/run-checks.sh
245+
timeout_secs: 60
246+
env:
247+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
248+
binary: bash
249+
args:
250+
- "${PROJECT_DIRECTORY}/.evergreen/run-lint-checks.sh"
251+
252+
"run unit tests":
253+
- command: subprocess.exec
254+
params:
255+
working_dir: "src"
256+
timeout_secs: 60
257+
env:
258+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
259+
binary: bash
260+
args:
261+
- "${PROJECT_DIRECTORY}/.evergreen/run-unit-tests.sh"
262+
263+
"run typescript next":
264+
- command: subprocess.exec
265+
params:
266+
working_dir: "src"
267+
timeout_secs: 60
268+
env:
269+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
270+
TS_VERSION: "next"
271+
binary: bash
272+
args:
273+
- "${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh"
274+
275+
"run typescript oldest":
276+
- command: subprocess.exec
277+
params:
278+
working_dir: "src"
279+
timeout_secs: 60
280+
env:
281+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
282+
TS_VERSION: "4.1.6"
283+
TRY_COMPILING_DRIVER: "false" # 4.1.6 can consume the public API but not compile the driver
284+
binary: bash
285+
args:
286+
- "${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh"
287+
288+
"run typescript current":
289+
- command: subprocess.exec
290+
params:
291+
working_dir: "src"
292+
timeout_secs: 60
293+
env:
294+
PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
295+
TS_VERSION: "" # leaving this empty will use the version in package-lock.json
296+
binary: bash
297+
args:
298+
- "${PROJECT_DIRECTORY}/.evergreen/run-typescript.sh"
249299

250300
"run mongosh integration tests":
251301
- command: shell.exec

‎.evergreen/generate_evergreen_tasks.js‎

Lines changed: 73 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -578,25 +578,87 @@ OPERATING_SYSTEMS.forEach(
578578
);
579579

580580
// singleton build variant for linting
581-
SINGLETON_TASKS.push({
582-
name: 'run-checks',
583-
tags: ['run-checks'],
584-
commands: [
581+
SINGLETON_TASKS.push(
582+
...[
585583
{
586-
func: 'install dependencies',
587-
vars: {
588-
NODE_LTS_NAME: LOWEST_LTS
589-
}
584+
name: 'run-unit-tests',
585+
tags: ['run-unit-tests'],
586+
commands: [
587+
{
588+
func: 'install dependencies',
589+
vars: {
590+
NODE_LTS_NAME: LOWEST_LTS
591+
}
592+
},
593+
{ func: 'run unit tests' }
594+
]
595+
},
596+
{
597+
name: 'run-lint-checks',
598+
tags: ['run-lint-checks'],
599+
commands: [
600+
{
601+
func: 'install dependencies',
602+
vars: {
603+
NODE_LTS_NAME: LOWEST_LTS
604+
}
605+
},
606+
{ func: 'run lint checks' }
607+
]
608+
},
609+
{
610+
name: 'run-typescript-next',
611+
tags: ['run-typescript-next'],
612+
commands: [
613+
{
614+
func: 'install dependencies',
615+
vars: {
616+
NODE_LTS_NAME: LOWEST_LTS
617+
}
618+
},
619+
{ func: 'run typescript next' }
620+
]
621+
},
622+
{
623+
name: 'run-typescript-current',
624+
tags: ['run-typescript-current'],
625+
commands: [
626+
{
627+
func: 'install dependencies',
628+
vars: {
629+
NODE_LTS_NAME: LOWEST_LTS
630+
}
631+
},
632+
{ func: 'run typescript current' }
633+
]
590634
},
591-
{ func: 'run checks' }
635+
{
636+
name: 'run-typescript-oldest',
637+
tags: ['run-typescript-oldest'],
638+
commands: [
639+
{
640+
func: 'install dependencies',
641+
vars: {
642+
NODE_LTS_NAME: LOWEST_LTS
643+
}
644+
},
645+
{ func: 'run typescript oldest' }
646+
]
647+
}
592648
]
593-
});
649+
);
594650

595651
BUILD_VARIANTS.push({
596652
name: 'lint',
597653
display_name: 'lint',
598654
run_on: DEFAULT_OS,
599-
tasks: ['run-checks']
655+
tasks: [
656+
'run-unit-tests',
657+
'run-lint-checks',
658+
'run-typescript-current',
659+
'run-typescript-oldest',
660+
'run-typescript-next'
661+
]
600662
});
601663

602664
// TODO NODE-3897 - generate combined coverage report

‎.evergreen/run-checks.sh‎ renamed to ‎.evergreen/run-lint-checks.sh‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,3 @@ set -o xtrace
1717

1818
## Checks typescript, eslint, and prettier
1919
npm run check:lint
20-
21-
npx nyc npm run check:unit
22-
23-
export TSC="./node_modules/typescript/bin/tsc"
24-
25-
echo "Typescript $($TSC -v)"
26-
# check resolution uses the default latest types
27-
echo "import * as mdb from '.'" > file.ts && $TSC --noEmit --traceResolution file.ts | grep 'mongodb.d.ts' && rm file.ts
28-
29-
npm i --no-save [email protected]
30-
echo "Typescript $($TSC -v)"
31-
$TSC --noEmit mongodb.ts34.d.ts
32-
# check that resolution uses the downleveled types
33-
echo "import * as mdb from '.'" > file.ts && $TSC --noEmit --traceResolution file.ts | grep 'mongodb.ts34.d.ts' && rm file.ts
34-
35-
rm -f file.ts

‎.evergreen/run-typescript.sh‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#!/bin/bash
2+
set -o errexit # Exit the script with error if any of the commands fail
3+
4+
source "${PROJECT_DIRECTORY}/.evergreen/init-nvm.sh"
5+
6+
set -o xtrace
7+
8+
function get_current_ts_version {
9+
node -e "console.log(require('./package-lock.json').dependencies.typescript.version)"
10+
}
11+
12+
CURRENT_TS_VERSION=$(get_current_ts_version)
13+
14+
export TSC="./node_modules/typescript/bin/tsc"
15+
export TS_VERSION=${TS_VERSION:=$CURRENT_TS_VERSION}
16+
17+
npm install --no-save --force typescript@"$TS_VERSION"
18+
19+
echo "Typescript $($TSC -v)"
20+
21+
# check resolution uses the default latest types
22+
echo "import * as mdb from '.'" > file.ts && node $TSC --noEmit --traceResolution file.ts | grep 'mongodb.d.ts' && rm file.ts
23+
24+
# check compilation
25+
node $TSC mongodb.d.ts
26+
27+
if [[ $TRY_COMPILING_DRIVER != "false" ]]; then
28+
npm run build:ts
29+
fi

‎.evergreen/run-unit-tests.sh‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/bash
2+
set -o errexit # Exit the script with error if any of the commands fail
3+
4+
source "${PROJECT_DIRECTORY}/.evergreen/init-nvm.sh"
5+
set -o xtrace
6+
7+
npx nyc npm run check:unit

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ For version compatibility matrices, please refer to the following links:
4646

4747
#### Typescript Version
4848

49-
We recommend using the latest version of typescript, however we do provide a [downleveled](https://github.com/sandersn/downlevel-dts#readme) version of the type definitions that we test compiling against `[email protected]`.
49+
We recommend using the latest version of typescript, however we currently ensure the driver's public types compile against `[email protected]`.
50+
This is the lowest typescript version guaranteed to work with our driver: older versions may or may not work - use at your own risk.
5051
Since typescript [does not restrict breaking changes to major versions](https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes) we consider this support best effort.
51-
If you run into any unexpected compiler failures please let us know and we will do our best to correct it.
52+
If you run into any unexpected compiler failures against our supported TypeScript versions please let us know by filing an issue on our [JIRA](https://jira.mongodb.org/browse/NODE).
5253

5354
## Installation
5455

0 commit comments

Comments
 (0)