forked from duckduckgo/duckduckgo-privacy-extension
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
executable file
·319 lines (239 loc) · 11.6 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
###--- Shared variables ---###
# Browser types (browser, but "chrome" adjusted as required)
BROWSER_TYPE = $(browser)
LEGACY_BROWSER = $(browser)
ifeq ('$(browser)','chrome')
LEGACY_BROWSER = chrome-mv3
endif
ifeq ('$(browser)','chrome-mv2')
BROWSER_TYPE = chrome
LEGACY_BROWSER = chrome
endif
# Output directory for builds.
BUILD_DIR = build/$(browser)/$(type)
ifeq ($(browser),test)
BUILD_DIR := build/test
endif
INTERMEDIATES_DIR = build/.intermediates
## All source files that potentially need to be bundled or copied.
WATCHED_FILES = $(shell find -L browsers/ shared/ packages/ unit-test/ -type f -not -path "packages/*/node_modules/*" -not -name "*~")
# If the node_modules/@duckduckgo/ directory exists, include those source files
# in the list too.
ifneq ("$(wildcard node_modules/@duckduckgo/)","")
WATCHED_FILES += $(shell find -L node_modules/@duckduckgo/ -type f -not -path "node_modules/@duckduckgo/*/.git/*" -not -path "node_modules/@duckduckgo/*/node_modules/*" -not -name "*~")
endif
###--- Top level targets ---###
# TODO:
# - Add default `help` target.
# - Set browser/type automatically where possible.
# - Add check that browser+type are set when necessary.
## release: Create a release build for a platform in build/$(browser)/release
## specify browser=(chrome|chrome-mv2|firefox) type=release
release: clean npm copy build
.PHONY: release
## chrome-beta: Create a beta Chrome build in build/$(browser)/release
## specify browser=chrome type=release
chrome-beta: release chrome-beta-zip
.PHONY: chrome-beta
## beta-firefox: Create a beta Firefox build in build/$(browser)/release
## specify browser=firefox type=release
beta-firefox: release beta-firefox-zip
.PHONY: beta-firefox
## dev: Create a debug build for a platform in build/$(browser)/dev.
## Pass reloader=0 to disable automatic extension reloading.
## specify browser=(chrome|chrome-mv2|firefox) type=dev [reloader=1]
dev: copy build $(BUILD_DIR)/buildtime.txt
.PHONY: dev
## watch: Create a debug build for a platform in build/$(browser)/dev, and keep
## it up to date as files are changed.
## Pass reloader=0 to disable automatic extension reloading.
## specify browser=(chrome|chrome-mv2|firefox) type=dev [reloader=1]
MAKE = make $(type) browser=$(browser) type=$(type)
watch:
$(MAKE)
@echo "\n** Build ready - Watching for changes **\n"
while true; do $(MAKE) -q --silent || $(MAKE); sleep 1; done
.PHONY: watch
## unit-test: Run the unit tests.
ESBUILD_TESTS = unit-test/background/*.js unit-test/background/**/*.js unit-test/ui/**/*.js unit-test/shared-utils/*.js
unit-test:
$(ESBUILD) --sourcemap=inline --outdir=build/test --inject:./unit-test/inject-chrome-shim.js $(ESBUILD_TESTS)
node_modules/.bin/karma start karma.conf.js
.PHONY: unit-test
NODE_TESTS = unit-test/node/**/*.js
node-test:
$(ESBUILD) --platform=node --outdir=build/node --inject:./unit-test/inject-chrome-shim.js --external:jsdom $(NODE_TESTS)
node_modules/.bin/jasmine build/node/*.js
## npm: Pull in the external dependencies (npm install).
npm:
npm ci --ignore-scripts
npm rebuild puppeteer
.PHONY: npm
## clean: Clear the builds and temporary files.
clean:
rm -f build/.smarter_encryption.txt integration-test/artifacts/attribution.json
rm -rf $(BUILD_DIR)
.PHONY: clean
###--- Release packaging ---###
chrome-release-zip:
rm -f build/chrome/release/chrome-release-*.zip
cd build/chrome/release/ && zip -rq chrome-release-$(shell date +"%Y%m%d_%H%M%S").zip *
.PHONY: chrome-release-zip
chrome-beta-zip: prepare-chrome-beta chrome-release-zip
.PHONY: chrome-beta-zip
prepare-chrome-beta:
sed 's/__MSG_appName__/DuckDuckGo Privacy Essentials Beta/' ./browsers/chrome/manifest.json > build/chrome/release/manifest.json
cp -r build/chrome/release/img/beta/* build/chrome/release/img/
.PHONY: prepare-chrome-beta
remove-firefox-id:
sed '/jid1-ZAdIEUB7XOzOJw@jetpack/d' ./browsers/firefox/manifest.json > build/firefox/release/manifest.json
.PHONY: remove-firefox-id
beta-firefox-zip: remove-firefox-id
cd build/firefox/release/ && web-ext build
.PHONY: beta-firefox-zip
###--- Integration test setup ---###
# Artifacts produced by the integration tests.
setup-artifacts-dir:
rm -rf integration-test/artifacts
mkdir -p integration-test/artifacts/screenshots
mkdir -p integration-test/artifacts/api_schemas
.PHONY: setup-artifacts-dir
###--- Mkdir targets ---#
# Note: Intermediate directories can be omitted.
MKDIR_TARGETS = $(BUILD_DIR)/_locales $(BUILD_DIR)/data/bundled $(BUILD_DIR)/html \
$(BUILD_DIR)/img $(BUILD_DIR)/dashboard $(BUILD_DIR)/web_accessible_resources \
$(BUILD_DIR)/public/js/content-scripts $(BUILD_DIR)/public/css \
$(BUILD_DIR)/public/font \
$(INTERMEDIATES_DIR)
$(MKDIR_TARGETS):
mkdir -p $@
###--- Copy targets ---###
# The empty $(LAST_COPY) file is used to keep track of file copying, since translating the necessary
# copying to proper Makefile targets is problematic.
# See https://www.gnu.org/software/make/manual/html_node/Empty-Targets.html
LAST_COPY = build/.last-copy-$(browser)-$(type)
RSYNC = rsync -ra --exclude="*~"
$(LAST_COPY): $(WATCHED_FILES) | $(MKDIR_TARGETS)
$(RSYNC) browsers/$(browser)/* browsers/chrome/_locales shared/data shared/html shared/img $(BUILD_DIR)
$(RSYNC) node_modules/@duckduckgo/privacy-dashboard/build/app/* $(BUILD_DIR)/dashboard
$(RSYNC) node_modules/@duckduckgo/autofill/dist/autofill.css $(BUILD_DIR)/public/css/autofill.css
$(RSYNC) node_modules/@duckduckgo/autofill/dist/autofill-host-styles_$(BROWSER_TYPE).css $(BUILD_DIR)/public/css/autofill-host-styles.css
$(RSYNC) node_modules/@duckduckgo/autofill/dist/*.js shared/js/content-scripts/*.js $(BUILD_DIR)/public/js/content-scripts
$(RSYNC) node_modules/@duckduckgo/tracker-surrogates/surrogates/* $(BUILD_DIR)/web_accessible_resources
touch $@
copy: $(LAST_COPY)
.PHONY: copy
###--- Build targets ---###
ESBUILD = node_modules/.bin/esbuild --bundle --target=firefox91,chrome92 --define:BUILD_TARGET=\"$(browser)\"
# Ensure sourcemaps are included for the bundles during development.
ifeq ($(type),dev)
ESBUILD += --sourcemap
endif
## Extension background/serviceworker script.
ifeq ($(type), dev)
# Developer builds include the devbuilds module for debugging.
ESBUILD += --define:DEBUG=true
# Unless reloader=0 is passed, they also contain an auto-reload module.
ifneq ($(reloader),0)
ESBUILD += --define:RELOADER=true
else
ESBUILD += --define:RELOADER=false
endif
else
ESBUILD += --define:DEBUG=false --define:RELOADER=false
endif
$(BUILD_DIR)/public/js/background.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/background/background.js > $@
## Locale resources for UI
shared/js/ui/base/locale-resources.js: $(shell find -L shared/locales/ -type f)
node scripts/bundleLocales.mjs > $@
## Extension UI/Devtools scripts.
$(BUILD_DIR)/public/js/base.js: $(WATCHED_FILES) shared/js/ui/base/locale-resources.js
mkdir -p `dirname $@`
$(ESBUILD) shared/js/ui/base/index.js > $@
$(BUILD_DIR)/public/js/feedback.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/ui/pages/feedback.js > $@
$(BUILD_DIR)/public/js/options.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/ui/pages/options.js > $@
$(BUILD_DIR)/public/js/devtools-panel.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/devtools/panel.js > $@
$(BUILD_DIR)/public/js/list-editor.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/devtools/list-editor.js > $@
$(BUILD_DIR)/public/js/newtab.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/newtab/newtab.js > $@
$(BUILD_DIR)/public/js/fire.js: $(WATCHED_FILES)
$(ESBUILD) shared/js/fire/index.js > $@
JS_BUNDLES = background.js base.js feedback.js options.js devtools-panel.js list-editor.js newtab.js fire.js
BUILD_TARGETS = $(addprefix $(BUILD_DIR)/public/js/, $(JS_BUNDLES))
## Content Scope Scripts
CONTENT_SCOPE_SCRIPTS = node_modules/@duckduckgo/content-scope-scripts
# Rebuild content-scope-scripts if it's a local checkout (.git is present), but
# not otherwise. That is important, since content-scope-scripts releases often
# have newer source files than build files.
CONTENT_SCOPE_SCRIPTS_DEPS =
CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS =
ifneq ("$(wildcard $(CONTENT_SCOPE_SCRIPTS)/.git/)","")
CONTENT_SCOPE_SCRIPTS_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/src $(CONTENT_SCOPE_SCRIPTS)/inject $(CONTENT_SCOPE_SCRIPTS)/scripts -type f -not -name "*~")
CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/package.json
CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/node_modules
CONTENT_SCOPE_SCRIPTS_DEPS += $(CONTENT_SCOPE_SCRIPTS)/build/locales
CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(shell find $(CONTENT_SCOPE_SCRIPTS)/src/locales $(CONTENT_SCOPE_SCRIPTS)/scripts)
CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(CONTENT_SCOPE_SCRIPTS)/package.json
CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS += $(CONTENT_SCOPE_SCRIPTS)/node_modules
endif
$(CONTENT_SCOPE_SCRIPTS)/node_modules: $(CONTENT_SCOPE_SCRIPTS)/package.json
cd $(CONTENT_SCOPE_SCRIPTS); npm install
touch $@
$(CONTENT_SCOPE_SCRIPTS)/build/locales: $(CONTENT_SCOPE_SCRIPTS_LOCALES_DEPS)
cd $(CONTENT_SCOPE_SCRIPTS); npm run build-locales
touch $@
$(CONTENT_SCOPE_SCRIPTS)/build/$(LEGACY_BROWSER)/inject.js: $(CONTENT_SCOPE_SCRIPTS_DEPS)
cd $(CONTENT_SCOPE_SCRIPTS); npm run build-$(LEGACY_BROWSER)
$(BUILD_DIR)/public/js/inject.js: $(CONTENT_SCOPE_SCRIPTS)/build/$(LEGACY_BROWSER)/inject.js shared/data/bundled/tracker-lookup.json shared/data/bundled/extension-config.json
node scripts/bundleContentScopeScripts.mjs $@ $^
BUILD_TARGETS += $(BUILD_DIR)/public/js/inject.js
## SASS
SASS = node_modules/.bin/sass
SCSS_SOURCE = $(shell find shared/scss/ -type f)
OUTPUT_CSS_FILES = $(BUILD_DIR)/public/css/options.css $(BUILD_DIR)/public/css/feedback.css
$(BUILD_DIR)/public/css/base.css: shared/scss/base/base.scss $(SCSS_SOURCE)
$(SASS) $< $@
$(BUILD_DIR)/public/css/%.css: shared/scss/%.scss $(SCSS_SOURCE)
$(SASS) $< $@
BUILD_TARGETS += $(BUILD_DIR)/public/css/base.css $(OUTPUT_CSS_FILES)
## Fonts
FONT_FILES = ProximaNova-Reg-webfont.woff ProximaNova-Sbold-webfont.woff ProximaNova-Bold-webfont.woff ProximaNova-Reg-webfont.woff2 ProximaNova-Bold-webfont.woff2
BUILD_TARGETS += $(addprefix $(BUILD_DIR)/public/font/, $(FONT_FILES))
$(BUILD_DIR)/public/font/%: $(INTERMEDIATES_DIR)/%
cp $< $@
# Fetch fonts from the webserver to be included in the generated build
.SECONDARY:
$(INTERMEDIATES_DIR)/%:
curl -s -o $@ https://duckduckgo.com/font/all/`basename $@`
## Other
# Fetch Smarter Encryption data for bundled Smarter Encryption
# declarativeNetRequest rules.
build/.smarter_encryption.txt:
curl https://staticcdn.duckduckgo.com/https/smarter_encryption.txt.gz | gunzip -c > $@
# Generate Smarter Encryption declarativeNetRequest rules for MV3 builds.
$(BUILD_DIR)/data/bundled/smarter-encryption-rules.json: build/.smarter_encryption.txt
npx ddg2dnr smarter-encryption $< $@
ifeq ('$(browser)','chrome')
BUILD_TARGETS += $(BUILD_DIR)/data/bundled/smarter-encryption-rules.json
endif
# Generate the list of "surrogate" (stub) scripts.
$(BUILD_DIR)/data/surrogates.txt: $(BUILD_DIR)/web_accessible_resources $(LAST_COPY)
node scripts/generateListOfSurrogates.js -i $</ > $@
.SECONDARY:
$(INTERMEDIATES_DIR)/surrogates.json: $(BUILD_DIR)/web_accessible_resources $(LAST_COPY)
node scripts/generateListOfSurrogates.js --json -i $</ > $@
BUILD_TARGETS += $(BUILD_DIR)/data/surrogates.txt
# Update buildtime.txt for development builds, for auto-reloading.
# Note: Keep this below the other build targets, since it depends on the
# $(BUILD_TARGETS) variable.
$(BUILD_DIR)/buildtime.txt: $(BUILD_TARGETS) $(LAST_COPY)
echo $(shell date +"%Y%m%d_%H%M%S") > $(BUILD_DIR)/buildtime.txt
# Ensure directories exist before build targets are created.
$(BUILD_TARGETS): | $(MKDIR_TARGETS)
build: $(BUILD_TARGETS)
.PHONY: build