Experimental Next.js 12 Output File Tracing #2169

iiroj · 2021-12-03T12:41:33Z

This PR implements the Next.js 12 Output File Tracing, meaning that @sls-next/serverless-component will no longer set any target while building Next.js, and will instead use the generated *.nft.json files to copy required files into the Lambda@Edge deployment.

To use the new feature, one should:

update to Next.js 12
make sure there is no target in the Next.js configuration (it's now deprecated)
set the build.outputFileTracing: true in the serverless.yml inputs for @sls-next/serverless-component

iiroj · 2021-12-03T12:42:33Z

Ping @dphang I replaced #2124 with this.

slsnextbot · 2021-12-03T12:46:47Z

Handler Size Report

No changes to handler sizes.

Base Handler Sizes (kB) (commit `e492064`)

{
    "Lambda": {
        "Default Lambda": {
            "Standard": 1524,
            "Minified": 668
        },
        "Image Lambda": {
            "Standard": 1488,
            "Minified": 800
        }
    },
    "Lambda@Edge": {
        "Default Lambda": {
            "Standard": 1534,
            "Minified": 673
        },
        "Default Lambda V2": {
            "Standard": 1526,
            "Minified": 670
        },
        "API Lambda": {
            "Standard": 634,
            "Minified": 318
        },
        "Image Lambda": {
            "Standard": 1496,
            "Minified": 805
        },
        "Regeneration Lambda": {
            "Standard": 1187,
            "Minified": 546
        },
        "Regeneration Lambda V2": {
            "Standard": 1253,
            "Minified": 573
        }
    }
}

New Handler Sizes (kB) (commit `a0b9240`)

{
    "Lambda": {
        "Default Lambda": {
            "Standard": 1524,
            "Minified": 668
        },
        "Image Lambda": {
            "Standard": 1488,
            "Minified": 800
        }
    },
    "Lambda@Edge": {
        "Default Lambda": {
            "Standard": 1534,
            "Minified": 673
        },
        "Default Lambda V2": {
            "Standard": 1526,
            "Minified": 670
        },
        "API Lambda": {
            "Standard": 634,
            "Minified": 318
        },
        "Image Lambda": {
            "Standard": 1496,
            "Minified": 805
        },
        "Regeneration Lambda": {
            "Standard": 1187,
            "Minified": 546
        },
        "Regeneration Lambda V2": {
            "Standard": 1253,
            "Minified": 573
        }
    }
}

codecov · 2021-12-03T12:53:31Z

Codecov Report

Merging #2169 (80c8989) into master (e492064) will decrease coverage by 0.06%.
The diff coverage is 91.39%.

❗ Current head 80c8989 differs from pull request most recent head a0b9240. Consider uploading reports for the commit a0b9240 to get more accurate results

@@            Coverage Diff             @@
##           master    #2169      +/-   ##
==========================================
- Coverage   83.54%   83.48%   -0.07%     
==========================================
  Files         102      104       +2     
  Lines        3671     3711      +40     
  Branches     1169     1189      +20     
==========================================
+ Hits         3067     3098      +31     
- Misses        592      601       +9     
  Partials       12       12

Impacted Files	Coverage Δ
...rless-components/nextjs-component/src/component.ts	`86.15% <75.00%> (-0.21%)`	⬇️
packages/libs/lambda-at-edge/src/build.ts	`92.96% <86.04%> (-3.12%)`	⬇️
.../lambda-at-edge/src/lib/copyRequiredServerFiles.ts	`92.85% <92.85%> (ø)`
...ibs/lambda-at-edge/src/lib/copyOutputFileTraces.ts	`100.00% <100.00%> (ø)`
...ges/libs/lambda-at-edge/src/lib/isPathInsideDir.ts	`100.00% <100.00%> (ø)`
...ponents/nextjs-component/__tests__/aws-sdk.mock.ts

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e492064...a0b9240. Read the comment docs.

jonahallibone · 2022-01-12T05:04:19Z

Is this a no-go? I'd really love to use the new output format

iiroj · 2022-01-12T08:06:31Z

@jonahallibone I haven't had time to write really exhaustive tests... In the meantime, it seems Next.js is already working on a way to do the output themselves: https://nextjs.org/docs/advanced-features/output-file-tracing#automatically-copying-traced-files-experimental

jest.config.js

packages/libs/core/src/build/builder.ts

packages/libs/lambda-at-edge/src/lib/copyOutputFileTraces.ts

packages/libs/lambda-at-edge/src/lib/copyRequiredServerFiles.ts

Purii · 2022-01-18T10:25:29Z

Awesome! We absolutely need this feature to include localization files.
Is there anything I can support with or is this PR only waiting for approval + merge by @dphang ?

iiroj · 2022-01-18T13:00:56Z

@Purii I do want to write more tests because otherwise the codecoverage check doesn't pass, but it does seem to work at least for my small site!

dphang · 2022-01-20T02:23:08Z

packages/serverless-components/nextjs-component/src/component.ts

+    const outputFileTracing =
+      typeof inputs.build !== "boolean" &&
+      typeof inputs.build !== "undefined" &&
+      !!inputs.build.outputFileTracing;


probably can cover it in custom inputs test? or if it's not too convenient, we could modify the existing e2e tests to cover this

I added a custom inputs test and also updated the next-app-experimental to use this flag.

dphang · 2022-01-20T02:24:09Z

thanks! I think it looks fine for the most part, codecov drop is just 0.08%, I gave a minor comment, I can probably add a new app to test this later so we get coverage there

…ion for Next.js 12

iiroj · 2022-01-25T07:08:58Z

@dphang I'm not familiar with the e2e test setup; would it make sense to run those before merging?

dphang · 2022-01-25T07:25:24Z

@dphang I'm not familiar with the e2e test setup; would it make sense to run those before merging?

Ran it here https://github.com/serverless-nextjs/serverless-next.js/actions/runs/1744128397 (there are some issues with the experimental app which I will fix later but if it passes on the other apps it should be fine)

iiroj · 2022-01-25T16:19:34Z

@dphang seems like another e2e app failed, how to debug? I'll try to run this branch locally against my own site if it catches any errors.

dphang · 2022-01-25T20:48:57Z

Ya that app is because somehow the IAM policy got corrupted, I need to manually fix it. But it should be fine since actually your changes is primarily build-time (the apps tests are to sanity check it doesn't break existing things) and experimental now so we can add more e2e tests later.

iiroj · 2022-01-27T17:45:21Z

@dphang did the tests fail because of this branch? Any way I can help debug them?

https://github.com/serverless-nextjs/serverless-next.js/actions/runs/1755195463

dphang · 2022-01-27T17:55:50Z

Hm I think a new minor version of nextjs yesterday is causing failures since we pick the latest one, need to look into logs and fix it but your changes hadn't failed earlier when I ran tests. I will check why it is failing, they may have introduced some new required files.

…2324) This reverts commit e01571f.

iiroj commented Jan 12, 2022

View reviewed changes

dphang reviewed Jan 20, 2022

View reviewed changes

dphang previously approved these changes Jan 24, 2022

View reviewed changes

iiroj added 2 commits January 24, 2022 18:02

test(lambda-at-edge): use Next.js 12 for unit tests

c4cd2bc

test: ignore test files themselves from coverage

17afa06

iiroj dismissed dphang’s stale review via 69e4bb6 January 24, 2022 16:02

iiroj changed the title ~~🚧 Next.js 12 Output File Tracing~~ Experimental Next.js 12 Output File Tracing Jan 24, 2022

iiroj requested a review from dphang January 24, 2022 17:06

iiroj added 2 commits January 24, 2022 19:15

feat(lambda-at-edge): add experimental build.outputFileTracing opt…

1864010

…ion for Next.js 12

test(e2e): use build.outputFileTracing in next-app-experimental

a0b9240

dphang approved these changes Jan 25, 2022

View reviewed changes

dphang merged commit e01571f into serverless-nextjs:master Jan 27, 2022

iiroj deleted the output-file-tracing branch January 27, 2022 08:11

iiroj mentioned this pull request Jan 29, 2022

fix: copy page traces when using build.outputFileTracing #2323

Closed

dphang pushed a commit that referenced this pull request Jan 31, 2022

revert: revert "Experimental Next.js 12 Output File Tracing (#2169)" (#…

ca7f7f7

…2324) This reverts commit e01571f.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experimental Next.js 12 Output File Tracing #2169

Experimental Next.js 12 Output File Tracing #2169

iiroj commented Dec 3, 2021 •

edited

Loading

iiroj commented Dec 3, 2021

slsnextbot commented Dec 3, 2021 •

edited

Loading

codecov bot commented Dec 3, 2021 •

edited

Loading

jonahallibone commented Jan 12, 2022

iiroj commented Jan 12, 2022

Purii commented Jan 18, 2022

iiroj commented Jan 18, 2022

dphang Jan 20, 2022

iiroj Jan 24, 2022

dphang commented Jan 20, 2022

iiroj commented Jan 25, 2022

dphang commented Jan 25, 2022

iiroj commented Jan 25, 2022

dphang commented Jan 25, 2022

iiroj commented Jan 27, 2022

dphang commented Jan 27, 2022

Experimental Next.js 12 Output File Tracing #2169

Experimental Next.js 12 Output File Tracing #2169

Conversation

iiroj commented Dec 3, 2021 • edited Loading

iiroj commented Dec 3, 2021

slsnextbot commented Dec 3, 2021 • edited Loading

Handler Size Report

Base Handler Sizes (kB) (commit e492064)

New Handler Sizes (kB) (commit a0b9240)

codecov bot commented Dec 3, 2021 • edited Loading

Codecov Report

jonahallibone commented Jan 12, 2022

iiroj commented Jan 12, 2022

Purii commented Jan 18, 2022

iiroj commented Jan 18, 2022

dphang Jan 20, 2022

Choose a reason for hiding this comment

iiroj Jan 24, 2022

Choose a reason for hiding this comment

dphang commented Jan 20, 2022

iiroj commented Jan 25, 2022

dphang commented Jan 25, 2022

iiroj commented Jan 25, 2022

dphang commented Jan 25, 2022

iiroj commented Jan 27, 2022

dphang commented Jan 27, 2022

iiroj commented Dec 3, 2021 •

edited

Loading

slsnextbot commented Dec 3, 2021 •

edited

Loading

Base Handler Sizes (kB) (commit `e492064`)

New Handler Sizes (kB) (commit `a0b9240`)

codecov bot commented Dec 3, 2021 •

edited

Loading