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

Fix Webpack configuration to use the minified pdf.worker file #55743

Conversation

rezkiy37
Copy link
Contributor

@rezkiy37 rezkiy37 commented Jan 24, 2025

Explanation of Change

The PR fixes Webpack configuration to use the minified pdf.worker file and align it with the PDFThumbnail. #55421 (comment)

Fixed Issues

$ #55176
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console
  1. Run web.
  2. Check Webpack logs.
  3. Verify that there is no the error associated with the pdf worker.
  4. Open any pdf file.
  5. Verify the app renders it properly.
  6. Verify no errors or warnings.
Screenshot

Logs

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console
  1. Open any pdf file.
  2. Verify the app renders it properly.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android

Android: mWeb Chrome

Android Chrome

iOS: Native IOS
iOS: mWeb Safari IOS Safari 2 IOS Safari
MacOS: Chrome / Safari Chrome
MacOS: Desktop Desktop

@rezkiy37 rezkiy37 marked this pull request as ready for review January 24, 2025 17:34
@rezkiy37 rezkiy37 requested a review from a team as a code owner January 24, 2025 17:34
@melvin-bot melvin-bot bot requested a review from jjcoffee January 24, 2025 17:34
@rezkiy37 rezkiy37 changed the title [WIP] Fix Webpack configuration to use the minified pdf.worker file Fix Webpack configuration to use the minified pdf.worker file Jan 24, 2025
@melvin-bot melvin-bot bot removed the request for review from a team January 24, 2025 17:34
Copy link

melvin-bot bot commented Jan 24, 2025

@jjcoffee Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the follow up

➜  App git:(fix/55176-webpack-pdf-worker-import) ✗ npm run web

> [email protected] web
> ./scripts/set-pusher-suffix.sh && concurrently npm:web-proxy npm:web-server

./scripts/set-pusher-suffix.sh: line 12: export: `': not a valid identifier
./scripts/set-pusher-suffix.sh: line 12: export: `': not a valid identifier
./scripts/set-pusher-suffix.sh: line 12: export: `': not a valid identifier
./scripts/set-pusher-suffix.sh: line 12: export: `': not a valid identifier
./scripts/set-pusher-suffix.sh: line 12: export: `': not a valid identifier
Using PUSHER_DEV_SUFFIX from ../Web-Expensify/_config.local.php
Found suffix: af92d6ff2b084f97a62e927faf647483
Updating .env
[web-server]
[web-server] > [email protected] web-server
[web-server] > webpack-dev-server --open --config config/webpack/webpack.dev.ts
[web-server]
[web-proxy]
[web-proxy] > [email protected] web-proxy
[web-proxy] > ts-node web/proxy.ts
[web-proxy]
[web-proxy] Creating proxy with host: www.expensify.com for production API and staging.expensify.com for staging API
[web-proxy] Proxy server listening at http://localhost:9000
[web-server] [time-analytics-webpack-plugin]: meet one minimizer which is a function, Time Analytics plugin could not analyze such situration.
[web-server] <i> [webpack-dev-server] [HPM] Proxy created: /api,/staging,/chat-attachments,/receipts  -> http://[::1]:9000
[web-server] (node:64904) [DEP_WEBPACK_COMPILATION_NORMAL_MODULE_LOADER_HOOK] DeprecationWarning: Compilation.hooks.normalModuleLoader was moved to NormalModule.getCompilationHooks(compilation).loader
[web-server] (Use `node --trace-deprecation ...` to show where the warning was created)
[web-server] <i> [webpack-dev-server] Project is running at:
[web-server] <i> [webpack-dev-server] Server: https://dev.new.expensify.com:8082/
[web-server] <i> [webpack-dev-server] Loopback: https://127.0.0.1:8082/
[web-server] <w> [webpack.cache.PackFileCacheStrategy/webpack.FileSystemInfo] Managed item /Users/vit/Expensidev isn't a directory or doesn't contain a package.json (see snapshot.managedPaths option)
[web-server] <i> [webpack-dev-server] Content not from webpack is served from '/Users/vit/Expensidev/App/dist' directory
[web-server] <i> [webpack-dev-server] 404s will fallback to '/index.html'
[web-server] <i> [webpack-dev-middleware] wait until bundle finished: /
[web-server] This is not a desktop build, adding babel-plugin-annotate-react
[web-server] babel.config.js
[web-server]   - api.version: 7.25.8
[web-server]   - api.env: development
[web-server]   - process.env.NODE_ENV: undefined
[web-server]   - process.env.BABEL_ENV: undefined
[web-server]   - running in:  babel-loader
[web-server] [BABEL] Note: The code generator has deoptimised the styling of /Users/vit/Expensidev/App/assets/images/home-background--desktop.svg as it exceeds the max of 500KB.
[web-server] [BABEL] Note: The code generator has deoptimised the styling of undefined as it exceeds the max of 500KB.
[web-server]
[web-server] ┌── time-analytics-webpack-plugin
[web-server] │ Webpack compile takes 83180.9015 ms
[web-server] ├── Plugins
[web-server] │ Plugin HtmlWebpackPlugin takes 13.6168 ms
[web-server] │ Plugin IgnorePlugin takes 9.6393 ms
[web-server] │ Plugin CopyPlugin takes 103.7364 ms
[web-server] │ Plugin PreloadPlugin takes 0.0699 ms
[web-server] │ Plugin ProvidePlugin takes 0.0624 ms
[web-server] │ Plugin EnvironmentPlugin takes 2.1728 ms
[web-server] │ Plugin DefinePlugin takes 0.1860 ms
[web-server] │ Plugin CleanWebpackPlugin takes 2.1468 ms
[web-server] │ All plugins take 131.6303 ms
[web-server] ├── Loaders
[web-server] │ Loader babel-loader takes 57106.1607 ms
[web-server] │ Loader @pmmmwh/react-refresh-webpack-plugin takes 155866.6496 ms
[web-server] │ Loader @svgr/webpack takes 200257.2053 ms
[web-server] │ Loader style-loader takes 5.1389 ms
[web-server] │ All loaders take 413235.1545 ms
[web-server]
[web-server] (node:64904) [DEP_WEBPACK_STATS_WARNINGS_FILTER] DeprecationWarning: config.stats.warningsFilter is deprecated in favor of config.ignoreWarnings
[web-server] assets by path cmaps/ 1.11 MiB 169 assets
[web-server] assets by info 117 MiB [immutable]
[web-server]   assets by chunk 3.34 MiB (auxiliary name: main) 28 assets
[web-server]   assets by path *.js 114 MiB 13 assets
[web-server] assets by path fonts/ 3.25 MiB 17 assets
[web-server] assets by path sounds/*.mp3 104 KiB
[web-server]   asset sounds/success.mp3 61.1 KiB [emitted] [from: assets/sounds/success.mp3] [copied]
[web-server]   + 3 assets
[web-server] assets by path css/*.css 14.1 KiB
[web-server]   asset css/AnnotationLayer.css 9.08 KiB [emitted] [from: node_modules/react-pdf/dist/esm/Page/AnnotationLayer.css] [copied]
[web-server]   + 3 assets
[web-server] assets by path .well-known/ 4.28 KiB
[web-server]   asset .well-known/apple-app-site-association 3.68 KiB [emitted] [from: .well-known/apple-app-site-association] [copied]
[web-server]   asset .well-known/assetlinks.json 614 bytes [emitted] [from: .well-known/assetlinks.json] [copied]
[web-server] + 9 assets
[web-server] Entrypoint main 69.2 MiB (3.34 MiB) = runtime-4a8a4d80a77655814e63.bundle.js 51.6 KiB lottiePlayer-d95d5abaaca4ec1e3fe6.bundle.js 5.06 MiB vendors-454ff9779ee7a8631a3f.bundle.js 41.7 MiB main-5d78f2c7f71fd0260453.bundle.js 22.3 MiB 28 auxiliary assets
[web-server] orphan modules 325 KiB [orphan] 268 modules
[web-server] runtime modules 34.7 KiB 20 modules
[web-server] modules by path ./node_modules/ 19.5 MiB 3494 modules
[web-server] modules by path ./src/ 14.9 MiB 2246 modules
[web-server] modules by path ./assets/ 4.4 MiB (javascript) 3.34 MiB (asset)
[web-server]   javascript modules 4.36 MiB 518 modules
[web-server]   asset modules 46.1 KiB (javascript) 3.34 MiB (asset) 34 modules
[web-server] modules by mime type image/svg+xml 24.7 KiB
[web-server]   data:image/svg+xml,%3Csvg width=%27.. 699 bytes [built] [code generated]
[web-server]   data:image/svg+xml;charset=utf-8,%3Csvg xmlns=%27.. 271 bytes [built] [code generated]
[web-server]   + 29 modules
[web-server] ./index.js 1.23 KiB [built] [code generated]
[web-server] ./wdyr.ts 1.7 KiB [built] [code generated]
[web-server] ./package.json 14.9 KiB [built] [code generated]
[web-server] ./config/proxyConfig.ts 1.25 KiB [built] [code generated]
[web-server]
[web-server] LOG from webpack.FileSystemInfo
[web-server] <w> Managed item /Users/vit/Expensidev isn't a directory or doesn't contain a package.json (see snapshot.managedPaths option)
[web-server] + 12 hidden lines
[web-server]
[web-server] 1 warning has detailed information that is not shown.
[web-server] Use 'stats.errorDetails: true' resp. '--stats-error-details' to show it.
[web-server]
[web-server] webpack 5.94.0 compiled successfully in 83184 ms

@mountiny
Copy link
Contributor

mountiny commented Jan 24, 2025

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mountiny mountiny merged commit f4c3726 into Expensify:main Jan 24, 2025
19 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@kavimuru
Copy link

Can you help with the following steps?

  1. Run web.
  2. Check Webpack logs.
  3. Verify that there is no the error associated with the pdf worker.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.90-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

@rezkiy37
Copy link
Contributor Author

Can you help with the following steps?

  1. Run web.
  2. Check Webpack logs.
  3. Verify that there is no the error associated with the pdf worker.

Yes, I can.

  1. Open the terminal.
  2. Go to the root of the project.
  3. Run npm run web.
  4. Verify that there are no errors associated with the pdf worker.

@kavimuru, does it make sense?

@mountiny
Copy link
Contributor

@rezkiy37 qa should just check the pdf works in safari

@rezkiy37
Copy link
Contributor Author

@mountiny, you are right. I left other steps for QA 🤔

Screenshot 2025-01-28 at 16 13 14

@mountiny
Copy link
Contributor

@kavimuru just check that the pdf attachments are showing correctly in mweb safari

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 success ✅

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.

4 participants