Use pruned DTS file for API report #4207

schmidt-sebastian · 2020-12-14T18:04:28Z

This PR hooks the "prune-dts" script into Firestor's API Extractor pipeline. It runs three phases:

Use API Extractor to generate a rollup DTS
Prune the rollup DTS to strip private symbols
Use API Extractor to generate the API report based on the pruned symbols

As you can see in the output, this removes all sort of weird private types from the API report.

Also changed the .eslint.json in prune-dts to be more efficient by not including all .ts files in the entire repo.

Fixes #4441

changeset-bot · 2020-12-14T18:04:31Z

⚠️ No Changeset found

Latest commit: c006e4b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

google-oss-bot · 2020-12-14T19:24:29Z

Size Analysis Report

Affected Products

No changes between base commit (9ac2093) and head commit (7407901).

Test Logs

schmidt-sebastian · 2021-02-05T16:48:26Z

@Feiyang1 I was wondering if you had an opinion here. Should we carry this forward?

google-oss-bot · 2021-02-10T21:51:10Z

Binary Size Report

Affected SDKs

No changes between base commit (9ac2093) and head commit (7407901).

Test Logs

Base (9ac2093b): https://github.com/firebase/firebase-js-sdk/actions/runs/562312672
Head (74079015): https://github.com/firebase/firebase-js-sdk/actions/runs/572678554

hsubox76 · 2021-02-16T17:29:04Z

packages/firestore/package.json

@@ -79,7 +78,8 @@
    "@firebase/app-types": "0.x"
  },
  "devDependencies": {
-    "@firebase/app": "0.6.14",
+    "@firebase/app": "0.6.13",


bump back up to 14

Yeah, I think this was causing all the build failures earlier.

hsubox76 · 2021-02-16T17:29:56Z

packages/firestore/package.json

@@ -27,9 +25,9 @@
    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
    "prettier": "prettier --write '*.js' '*.ts' '@(lite|exp|src|test)/**/*.ts'",
-    "pregendeps:exp": "yarn api-report:exp && node scripts/build-bundle.js --input ./exp/index.ts --output ./dist/exp/tmp.js",
+    "pregendeps:exp": "yarn api-report&& node scripts/build-bundle.js --input ./exp/index.ts --output ./dist/exp/tmp.js",


Space before && (don't think it NEEDS it but for formatting)

schmidt-sebastian · 2021-02-16T17:33:34Z

Added bug fix to Prune DTS so that it no longer replaces PromiseLike with LoadBundleTask.

hsubox76

LGTM, I don't know if @Feiyang1 wants to take a second glance at the api-report script.

packages/firestore/package.json

packages/firestore/scripts/api-report.ts

packages/firestore/tsconfig.json

packages/firestore/package.json

packages/firestore/scripts/api-report.ts

Feiyang1 · 2021-02-16T18:42:16Z

packages/firestore/package.json

@@ -46,7 +44,8 @@
    "test:node:persistence:prod": "node ./scripts/run-tests.js --main=index.node.ts --persistence 'test/{,!(browser|lite)/**/}*.test.ts'",
    "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
    "test:minified": "(cd ../../integration/firestore ; yarn test)",
-    "api-report": "rm -rf temp && api-extractor run --local --verbose",
+    "prepare": "yarn build:release",
+    "api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ./scripts/api-report.js",


Should we execute api-report.ts directly since we are using ts-node. Then we won't need to commit the compiled js.

The compiled JS gets committed because of the yarn build:scripts rule which is needed because of rollup. I fixed this line though since using ts-node and the .js script is pretty... awkward.

Co-authored-by: Feiyang <[email protected]>

…-js-sdk into mrschmidt/apiextractor

schmidt-sebastian

Addressed feedback. Thanks for making most of it clickable :)

schmidt-sebastian · 2021-02-16T19:36:14Z

packages/firestore/package.json

@@ -46,7 +44,8 @@
    "test:node:persistence:prod": "node ./scripts/run-tests.js --main=index.node.ts --persistence 'test/{,!(browser|lite)/**/}*.test.ts'",
    "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
    "test:minified": "(cd ../../integration/firestore ; yarn test)",
-    "api-report": "rm -rf temp && api-extractor run --local --verbose",
+    "prepare": "yarn build:release",
+    "api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ./scripts/api-report.js",


The compiled JS gets committed because of the yarn build:scripts rule which is needed because of rollup. I fixed this line though since using ts-node and the .js script is pretty... awkward.

packages/firestore/scripts/api-report.ts

packages/firestore/tsconfig.json

Use pruned DTS file for API report

1e507ed

schmidt-sebastian requested review from Feiyang1, hiranya911 and hsubox76 as code owners December 14, 2020 18:04

schmidt-sebastian assigned hsubox76 Dec 14, 2020

schmidt-sebastian added the api: firestore label Dec 14, 2020

schmidt-sebastian added 2 commits December 14, 2020 11:23

Fix eslint

595f108

Use tsnode

298ae16

schmidt-sebastian assigned Feiyang1 Jan 5, 2021

schmidt-sebastian mentioned this pull request Jan 29, 2021

Release Bundles for Next SDK #4352

Merged

Merge

620bb85

schmidt-sebastian requested a review from jsdt as a code owner February 10, 2021 21:20

Fix run tests

f7b6c3b

schmidt-sebastian added 8 commits February 11, 2021 10:21

Don't rewrite DOM types

6595773

Comment

db96c5e

Merge branch 'master' into mrschmidt/apiextractor

8dff58a

Rebuild all

7d23395

Add Copyright

8e43826

Add comment

5005476

More comments

591fd74

downlevelIteration

1dd62e1

schmidt-sebastian mentioned this pull request Feb 12, 2021

Remove downlevelIteration from firebaseApp #4471

Merged

Feiyang1 and others added 2 commits February 16, 2021 10:21

Publish firebase@exp 0.900.13

bac0a1d

Update Yarn lock

6c99bde

schmidt-sebastian force-pushed the mrschmidt/apiextractor branch from b9c52e3 to 6c99bde Compare February 16, 2021 17:21

Fix build

7019268

wu-hui mentioned this pull request Feb 16, 2021

alpha: Type 'LoadBundleTask' is not generic #4441

Closed

hsubox76 reviewed Feb 16, 2021

View reviewed changes

Undo unrelated diff

a34c978

hsubox76 reviewed Feb 16, 2021

View reviewed changes

Fix formatting

0741cf5

hsubox76 approved these changes Feb 16, 2021

View reviewed changes

Feiyang1 suggested changes Feb 16, 2021

View reviewed changes

schmidt-sebastian and others added 8 commits February 16, 2021 12:32

Update packages/firestore/package.json

3cac57e

Co-authored-by: Feiyang <[email protected]>

Update packages/firestore/package.json

e31f08b

Co-authored-by: Feiyang <[email protected]>

Update packages/firestore/scripts/api-report.ts

d7a6574

Co-authored-by: Feiyang <[email protected]>

Use TS file

86cd798

Update packages/firestore/scripts/api-report.ts

290a317

Co-authored-by: Feiyang <[email protected]>

Merge

51795fc

Merge branch 'mrschmidt/apiextractor' of github.com:firebase/firebase…

063c803

…-js-sdk into mrschmidt/apiextractor

Undo yarn update

c006e4b

schmidt-sebastian commented Feb 16, 2021

View reviewed changes

Feiyang1 approved these changes Feb 16, 2021

View reviewed changes

schmidt-sebastian merged commit 536b47e into master Feb 16, 2021

schmidt-sebastian deleted the mrschmidt/apiextractor branch February 16, 2021 21:37

firebase locked and limited conversation to collaborators Mar 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use pruned DTS file for API report #4207

Use pruned DTS file for API report #4207

schmidt-sebastian commented Dec 14, 2020 •

edited

Loading

changeset-bot bot commented Dec 14, 2020 •

edited

Loading

google-oss-bot commented Dec 14, 2020 •

edited

Loading

Affected Products

Test Logs

schmidt-sebastian commented Feb 5, 2021

google-oss-bot commented Feb 10, 2021 •

edited

Loading

hsubox76 Feb 16, 2021

schmidt-sebastian Feb 16, 2021

hsubox76 Feb 16, 2021

schmidt-sebastian Feb 16, 2021

schmidt-sebastian commented Feb 16, 2021

hsubox76 left a comment

Feiyang1 Feb 16, 2021

schmidt-sebastian Feb 16, 2021

schmidt-sebastian left a comment

schmidt-sebastian Feb 16, 2021

Use pruned DTS file for API report #4207

Use pruned DTS file for API report #4207

Conversation

schmidt-sebastian commented Dec 14, 2020 • edited Loading

changeset-bot bot commented Dec 14, 2020 • edited Loading

⚠️ No Changeset found

google-oss-bot commented Dec 14, 2020 • edited Loading

Size Analysis Report

Affected Products

Test Logs

schmidt-sebastian commented Feb 5, 2021

google-oss-bot commented Feb 10, 2021 • edited Loading

Binary Size Report

Affected SDKs

Test Logs

hsubox76 Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian Feb 16, 2021

Choose a reason for hiding this comment

hsubox76 Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian commented Feb 16, 2021

hsubox76 left a comment

Choose a reason for hiding this comment

Feiyang1 Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian left a comment

Choose a reason for hiding this comment

schmidt-sebastian Feb 16, 2021

Choose a reason for hiding this comment

schmidt-sebastian commented Dec 14, 2020 •

edited

Loading

changeset-bot bot commented Dec 14, 2020 •

edited

Loading

google-oss-bot commented Dec 14, 2020 •

edited

Loading

google-oss-bot commented Feb 10, 2021 •

edited

Loading