Skip to content

Switch to Terser library for minification. #163

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Switch to Terser library for minification. #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65299a7
Switch to Terser library for minification.
sanason Feb 20, 2025
1a677d6
Have the CI build enforce the use of terser.
sanason Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
pull_request:

jobs:
lint:
build:
runs-on: ubuntu-latest
steps:
- name: Code Checkout
Expand All @@ -17,3 +17,8 @@ jobs:
run: npm ci --timing
- name: Lint javascript
run: npm run lint
- name: Verify minification uses script
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is hacky but I'd like to prevent a re-occurrence of the the situation where package.json suggests that we're using minifier A when really we're using minifier B.

The proper thing to do would be to delete the generated files from source control and have deployment be based on a built artifact. However, given that this project is about to lose most of its engineering support, I don't think this is the right time to make such a change.

run: |
npm run minify
git diff --exit-code Universal-Federated-Analytics-Min.js Universal-Federated-Analytics-Min.js.map

2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FROM nginx
ARG DAP_ENV='dev'
ENV DAP_ENV=${DAP_ENV}
COPY test_site Universal-Federated-Analytics-Min.js Federated.js.map /usr/share/nginx/html/
COPY test_site Universal-Federated-Analytics.js Universal-Federated-Analytics-Min.js Universal-Federated-Analytics-Min.js.map /usr/share/nginx/html/
COPY nginx-test.conf.template /etc/nginx/conf.d/
RUN envsubst '${DAP_ENV}' < /etc/nginx/conf.d/nginx-test.conf.template > /etc/nginx/conf.d/default.conf
8 changes: 0 additions & 8 deletions Federated.js.map
View file
Open in desktop

This file was deleted.

10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The latest version 8.6 of DAP GA code contains GA4 tracking only. DAP UA data co

* [`Universal-Federated-Analytics.js`](Universal-Federated-Analytics.js) (full)
* [`Universal-Federated-Analytics-Min.js`](Universal-Federated-Analytics-Min.js) (minified)
* [`Federated.js.map`](Federated.js.map) (source map)
* [`Universal-Federated-Analytics-Min.js.map`](Universal-Federated-Analytics-Min.js.map) (source map)

### DAP Code Implementation

Expand Down Expand Up @@ -129,6 +129,14 @@ This repo uses Eslint for code static analysis. Run the linter with:
npm run lint
```

#### Minification

This repo uses Terser for minification. After making changes to Universal-Federated-Analytics.js, regenerate the minified file by running:

```bash
npm run minify
```

#### Run integration tests

Start up the test site at http://localhost:8080/ with one of the following:
Expand Down
123 changes: 66 additions & 57 deletions Universal-Federated-Analytics-Min.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions Universal-Federated-Analytics-Min.js.map
View file
Open in desktop

Large diffs are not rendered by default.

93 changes: 92 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"scripts": {
"clean": "rm ./Universal-Federated-Analytics-Min.js",
"lint": "eslint Universal-Federated-Analytics.js",
"minify": "terser Universal-Federated-Analytics.js --output Universal-Federated-Analytics-Min.js --config-file terser.config.json",
"cucumber": "cucumber-js",
"cucumber:debug": "VERBOSE=true node --inspect-brk node_modules/@cucumber/cucumber/bin/cucumber-js",
"test-site-dev": "docker build --no-cache --build-arg DAP_ENV='dev' -t dap-test-site-dev . && docker run --rm -p 8080:80 --name dap-test-site-dev dap-test-site-dev",
Expand All @@ -28,7 +29,8 @@
"eslint": "^9.8.0",
"eslint-plugin-compat": "^6.0.0",
"eslint-plugin-jsdoc": "^50.2.2",
"puppeteer": "^23.3.0"
"puppeteer": "^23.3.0",
"terser": "^5.39.0"
},
"dependencies": {
"web-vitals": "^4.2.4"
Expand Down
9 changes: 9 additions & 0 deletions terser.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"sourceMap": {
"filename": "Universal-Federated-Analytics-Min.js",
"url": "Universal-Federated-Analytics-Min.js.map"
},
"format": {
"max_line_len": 500
}
}
Loading