Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: turn on noOptionalProperties and useBrandedStringAliases for fdr #1532

Merged
merged 21 commits into from
Sep 24, 2024

Conversation

abvthecity
Copy link
Contributor

@abvthecity abvthecity commented Sep 23, 2024

turns on noOptionalProperties and useBrandedStringAliases


This is largely a noop change and is a prerequisite for

  1. introducing new navigation types and safely handling read vs write types in the api, which will let us add a new canonical url field: fix: add cannonical self-referential urls #1526
  2. plumbing through all new properties for API reference related to descriptions, defaults, min, max, regexp, etc. chore: move ResolvedApiDefinition upstream into FDR typings #1523

Limitions on the sdk generator that required some hackery:.fernignore only ignores files that have been specifically edited, but will keep generated files around if no manual overrides exist. that means i couldn't ignore the stream-wrappers folder except by adding //ignore comment to each file.

Copy link

@abvthecity abvthecity had a problem deploying to Preview - dashboard-dev.buildwithfern.com September 23, 2024 23:12 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 23, 2024 23:13 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 23, 2024 23:13 — with GitHub Actions Failure
Copy link

@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 23, 2024 23:24 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 23, 2024 23:24 — with GitHub Actions Failure
Copy link

@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 23, 2024 23:49 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 23, 2024 23:49 — with GitHub Actions Failure
Copy link

@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 24, 2024 00:11 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 24, 2024 00:11 — with GitHub Actions Failure
Copy link

Copy link

@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 24, 2024 02:05 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 24, 2024 02:05 — with GitHub Actions Failure
Copy link

@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 24, 2024 02:49 — with GitHub Actions Error
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 24, 2024 02:49 — with GitHub Actions Error
Copy link

@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com September 24, 2024 06:26 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com September 24, 2024 06:26 — with GitHub Actions Failure
Copy link

github-actions bot commented Sep 24, 2024

Playwright test results

passed  1 passed

Details

stats  1 test across 1 suite
duration  9.1 seconds
commit  8d2d907

Copy link

@abvthecity abvthecity changed the title chore: fdr sdk types chore: turns on noOptionalProperties and useBrandedStringAliases for fdr Sep 24, 2024
@abvthecity abvthecity changed the title chore: turns on noOptionalProperties and useBrandedStringAliases for fdr chore: turn on noOptionalProperties and useBrandedStringAliases for fdr Sep 24, 2024
Copy link

github-actions bot commented Sep 24, 2024

PR Preview

Copy link

github-actions bot commented Sep 24, 2024

📦 Next.js Bundle Analysis for fern-platform-monorepo

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page Size (compressed)
global 240.3 KB (🟢 -16.98 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

New Page Added

The following page was added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/404 447 B 240.74 KB 68.78%

Two Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/dynamic/[host]/[[...slug]] 51.64 KB 291.94 KB 83.41% (🟢 -7.28%)
/static/[host]/[[...slug]] 51.64 KB 291.94 KB 83.41% (🟢 -7.28%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

github-actions bot commented Sep 24, 2024

Playwright test results

passed  81 passed

Details

stats  81 tests across 3 suites
duration  1 minute, 10 seconds
commit  b0a0fd3

@abvthecity abvthecity enabled auto-merge (squash) September 24, 2024 06:51
Copy link

Copy link

Copy link

Copy link

@abvthecity abvthecity merged commit ad0a7a0 into main Sep 24, 2024
22 checks passed
@abvthecity abvthecity deleted the ajiang/fdr-sdk-types branch September 24, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants