Stowage/tutanota
2
0
Fork 0
mirror of https://github.com/tutao/tutanota.git synced 2025-12-08 06:09:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
tutanota/buildSrc/RollupConfig.js
sug f11e59672e
improve inbox rule handling and run spam prediction after inbox rules 
Instead of applying inbox rules based on the unread mail state in the
inbox folder, we introduce the new ProcessingState enum on
the mail type. If a mail has been processed by the leader client, which
is checking for matching inbox rules, the ProcessingState is
updated. If there is a matching rule the flag is updated through the
MoveMailService, if there is no matching rule, the flag is updated
using the ClientClassifierResultService. Both requests are
throttled / debounced. After processing inbox rules, spam prediction
is conducted for mails that have not yet been moved by an inbox rule.
The ProcessingState for not matching ham mails is also updated using
the ClientClassifierResultService.

This new inbox rule handing solves the following two problems:
 - when clicking on a notification it could still happen,
   that sometimes the inbox rules where not applied
 - when the inbox folder had a lot of unread mails, the loading time did
   massively increase, since inbox rules were re-applied on every load

Co-authored-by: amm <amm@tutao.de>
Co-authored-by: Nick <nif@tutao.de>
Co-authored-by: das <das@tutao.de>
Co-authored-by: abp <abp@tutao.de>
Co-authored-by: jhm <17314077+jomapp@users.noreply.github.com>
Co-authored-by: map <mpfau@users.noreply.github.com>
Co-authored-by: Kinan <104761667+kibibytium@users.noreply.github.com>
2025-10-22 09:40:45 +02:00

431 lines
16 KiB
JavaScript
Raw Blame History

import path from "node:path"
/**
* These are the vendored dependencies. This map is to help bundler find the resolved path.
* Must stay in sync with ./updateLibs.js
*/
export const dependencyMap = {
mithril: path.normalize("./libs/mithril.js"),
"mithril/stream": path.normalize("./libs/stream.js"),
"squire-rte": path.normalize("./libs/squire-raw.mjs"),
dompurify: path.normalize("./libs/purify.js"),
"qrcode-svg": path.normalize("./libs/qrcode.js"),
jszip: path.normalize("./libs/jszip.js"),
luxon: path.normalize("./libs/luxon.js"),
linkifyjs: path.normalize("./libs/linkify.js"),
"linkify-html": path.normalize("./libs/linkify-html.js"),
cborg: path.normalize("./libs/cborg.js"),
// below this, the modules are only running in the desktop main thread.
"electron-updater": path.normalize("./libs/electron-updater.mjs"),
undici: path.normalize("./libs/undici.mjs"),
jsqr: path.normalize("./libs/jsQR.js"),
"@signalapp/sqlcipher": path.normalize("./libs/node-sqlcipher.mjs"),
"@fingerprintjs/botd": path.normalize("./libs/botd.mjs"),
"./tensorflow-custom": path.normalize("./libs/tensorflow.js"),
}
/**
* These are the definitions of chunks with static dependencies. Key is the chunk and values are dependencies to other chunks
*/
export const allowedImports = {
"polyfill-helpers": [],
"wasm-fallback": [],
wasm: ["wasm-fallback"],
"common-min": ["polyfill-helpers"],
boot: ["polyfill-helpers", "common-min"],
common: ["polyfill-helpers", "common-min"],
"gui-base": ["polyfill-helpers", "common-min", "common", "boot"],
main: ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "date", "spam-classifier"],
sanitizer: ["polyfill-helpers", "common-min", "common", "boot", "gui-base"],
date: ["polyfill-helpers", "common-min", "common"],
"date-gui": ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "sharing", "date", "contacts", "ui-extra"],
"mail-view": ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main"],
"mail-editor": ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "mail-view", "sanitizer", "sharing", "date-gui"],
search: ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "mail-view", "calendar-view", "contacts", "date", "date-gui", "sharing"],
// ContactMergeView needs HtmlEditor even though ContactEditor doesn't?
contacts: ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "mail-view", "date", "date-gui", "mail-editor"],
"calendar-view": ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "date", "date-gui", "sharing", "contacts"],
login: ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main"],
"spam-classifier": ["polyfill-helpers", "common", "common-min"],
worker: ["polyfill-helpers", "common-min", "common", "native-common", "native-worker", "wasm", "wasm-fallback"],
"pow-worker": [],
settings: [
"polyfill-helpers",
"common-min",
"common",
"boot",
"gui-base",
"main",
"contacts",
"sanitizer",
"mail-editor",
"mail-view",
"date",
"date-gui",
"login",
"sharing",
],
"mail-settings": [
"polyfill-helpers",
"common-min",
"common",
"boot",
"gui-base",
"main",
"contacts",
"sanitizer",
"mail-editor",
"mail-view",
"date",
"date-gui",
"login",
"sharing",
"settings",
"native-main",
"ui-extra",
],
"calendar-settings": [
"polyfill-helpers",
"common-min",
"common",
"boot",
"gui-base",
"main",
"contacts",
"sanitizer",
"mail-editor",
"mail-view",
"date",
"date-gui",
"login",
"sharing",
"settings",
"ui-extra",
],
"ui-extra": [
"polyfill-helpers",
"common-min",
"common",
"boot",
"gui-base",
"main",
"settings",
"mail-settings",
"calendar-settings",
"contacts",
"sanitizer",
"login",
"mail-editor",
],
sharing: ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main"],
"native-common": ["polyfill-helpers", "common-min", "common"],
"native-main": ["polyfill-helpers", "common-min", "common", "boot", "gui-base", "main", "native-common", "login"],
"native-worker": ["polyfill-helpers", "common-min", "common"],
"setup-wizard": ["boot", "common-min", "gui-base", "main", "native-common", "native-main", "settings", "mail-settings", "calendar-settings", "ui-extra"],
jszip: ["polyfill-helpers"],
"worker-lazy": ["common-min", "common", "worker", "worker-search", "date"],
"worker-search": ["common-min", "common", "worker", "worker-lazy"],
linkify: [],
invoice: ["common-min"],
"material-color-utilities": [],
}
/** resolves certain imports to vendored libraries for the dist build */
export function resolveLibs(baseDir = ".") {
return {
name: "resolve-libs",
resolveId(source) {
const value = dependencyMap[source]
if (!value) return null
const id = path.join(baseDir, value)
return { id, resolvedBy: this.name }
},
}
}
/**
* Returns the chunk name for the given moduleId which is usually the file path.
* @param moduleId Rollup moduleId usually the file path.
* @param getModuleInfo Helper function to get information about the ES module.
* @returns {string} Chunk name
*/
export function getChunkName(moduleId, { getModuleInfo }) {
// See HACKING.md for rules
const moduleInfo = getModuleInfo(moduleId)
const code = moduleInfo.code
if (code == null) {
console.log("SYNTHETIC MODULE??", moduleId)
}
function isIn(subpath) {
return moduleId.includes(path.normalize(subpath))
}
if (code.includes("@bundleInto:common-min") || isIn("libs/stream") || isIn("packages/tutanota-utils") || isIn("packages/tutanota-error")) {
// if detecting this does not work even though the comment is there, add a blank line after the annotation.
return "common-min"
} else if (code.includes("@bundleInto:common")) {
// if detecting this does not work even though the comment is there, add a blank line after the annotation.
return "common"
} else if (isIn("src/common/contactsFunctionality") || isIn("src/common/mailFunctionality")) {
return "main"
} else if (
code.includes("assertMainOrNodeBoot") ||
isIn("libs/mithril") ||
isIn("src/mail-app/app.ts") ||
isIn("src/calendar-app/calendar-app.ts") ||
code.includes("@bundleInto:boot") ||
moduleId.includes("libs/botd.mjs")
) {
// if detecting this does not work even though the comment is there, add a blank line after the annotation.
// everything marked as assertMainOrNodeBoot goes into boot bundle right now
// (which is getting merged into app.js)
return "boot"
} else if (
isIn("src/calendar-app/calendar/export") ||
isIn("src/common/misc/DateParser") ||
isIn("src/common/misc/ElevenYearsTutaUtils") ||
isIn("src/calendar-app/calendar/model") ||
isIn("src/calendar-app/calendar/gui") ||
isIn("src/common/calendar/gui") ||
isIn("src/mail-app/gui/date")
) {
// this contains code that is important to the calendar view but might be used by other parts of the app on the main thread
// like time-based input components and formatting code.
return "date-gui"
} else if (moduleId.includes("luxon") || isIn("src/common/calendar/date")) {
// common calendar/time code that might be used in main or worker threads
// primarily luxon and utility functions based on it, but no display code
// (formatting, UI components)
return "date"
} else if (isIn("src/common/misc/HtmlSanitizer") || isIn("libs/purify")) {
return "sanitizer"
} else if (isIn("src/common/gui/base")) {
// these gui elements are used from everywhere
return "gui-base"
} else if (isIn("src/common/native/main/wizard")) {
return "setup-wizard"
} else if (isIn("src/common/native/main") || isIn("src/mail-app/native/main") || moduleId.includes("SearchInPageOverlay")) {
return "native-main"
} else if (
isIn("src/mail-app/mail/editor") ||
moduleId.includes("squire") ||
isIn("src/common/gui/editor") ||
isIn("src/mail-app/mail/signature") ||
isIn("src/mail-app/templates") ||
isIn("src/mail-app/knowledgebase") ||
isIn("src/mail-app/mail/press")
) {
// squire is most often used with mail editor, and they are both not too big so we merge them
return "mail-editor"
} else if (
isIn("src/common/api/main") ||
isIn("src/mail-app/mail/model") ||
isIn("src/mail-app/contacts/model") ||
isIn("src/mail-app/search/model") ||
isIn("src/calendar-app/calendar/search/model") ||
isIn("src/common/misc") ||
isIn("src/common/file") ||
isIn("src/common/gui") ||
isIn("src/common/offline") ||
isIn("src/common/serviceworker") ||
moduleId.includes(path.normalize("packages/tutanota-usagetests")) ||
moduleId.includes("NotificationContentSelector") ||
moduleId.includes("NotificationPermissionsDialog") ||
moduleId.includes("SettingsBannerButton")
) {
// Things which we always need for main thread anyway, at least currently
return "main"
} else if (isIn("src/mail-app/mail/view") || isIn("src/mail-app/mail/export")) {
return "mail-view"
} else if (moduleId.includes("wasm-loader")) {
return "wasm"
} else if (moduleId.includes("wasm-fallback")) {
return "wasm-fallback"
} else if (isIn("src/mail-app/workerUtils/spamClassification") || moduleId.includes("libs/tensorflow.js")) {
return "spam-classifier"
} else if (
isIn("src/common/native/worker") ||
isIn("src/mail-app/workerUtils/worker") ||
isIn("src/calendar-app/worker") ||
isIn("src/mail-app/workerUtils/offline")
) {
return "worker"
} else if (moduleId.includes("pow-worker") || moduleId.includes("ProofOfWorkCaptchaUtils")) {
return "pow-worker"
} else if (isIn("src/common/native/common")) {
return "native-common"
} else if (isIn(`src/mail-app/search`) || isIn(`src/calendar-app/calendar/search`) || isIn("src/common/search")) {
return "search"
} else if (isIn("src/calendar-app/calendar/view")) {
return "calendar-view"
} else if (isIn("src/mail-app/contacts")) {
return "contacts"
} else if (isIn("src/common/login/recover") || isIn("src/common/support") || isIn("src/common/login/contactform")) {
// Collection of small UI components which are used not too often
// Perhaps contact form should be separate
// Recover things depends on HtmlEditor which we don't want to load on each login
return "ui-extra"
} else if (isIn("src/common/login")) {
return "login"
} else if (
isIn("src/common/api/common") ||
isIn("src/common/api/entities") ||
isIn("src/desktop/config/ConfigKeys") ||
moduleId.includes("cborg") ||
// CryptoError is needed on the main thread in order to check errors
// We have to define both the entry point and the files referenced from it which is annoying
isIn("packages/tutanota-crypto/dist/error") ||
isIn("packages/tutanota-crypto/dist/misc/CryptoError.js")
) {
// things that are used in both worker and client
// entities could be separate in theory but in practice they are anyway
return "common"
} else if (
moduleId.includes("rollupPluginBabelHelpers") ||
moduleId.includes("commonjsHelpers") ||
moduleId.includes("tslib") ||
moduleId.includes("commonjs-dynamic-modules")
) {
return "polyfill-helpers"
} else if (
isIn("src/common/settings") ||
isIn("src/common/subscription") ||
isIn("libs/qrcode") ||
isIn("src/common/ratings") ||
isIn("libs/jsQR") ||
isIn("src/common/termination")
) {
// subscription and settings depend on each other right now.
// subscription is also a kitchen sink with signup, utils and views, we should break it up
return "settings"
} else if (isIn("src/mail-app/settings")) {
return "mail-settings"
} else if (isIn("src/calendar-app/calendar/settings")) {
return "calendar-settings"
} else if (isIn("src/common/sharing")) {
return "sharing"
} else if (isIn("src/common/api/worker/facades/lazy")) {
// things that are not used for login and are generally accessed occasionally
return "worker-lazy"
} else if (isIn("src/common/api/worker/search") || isIn("src/mail-app/workerUtils/index")) {
// things related to indexer or search
return "worker-search"
} else if (isIn("src/common/api/worker/Urlifier") || isIn("libs/linkify") || isIn("libs/linkify-html")) {
return "linkify"
} else if (isIn("src/common/api/worker/pdf") || isIn("src/common/api/worker/invoicegen")) {
return "invoice"
} else if (isIn("src/common/api/worker") || isIn("packages/tutanota-crypto") || moduleId.includes("argon2")) {
return "worker" // avoid that crypto stuff is only put into native
} else if (isIn("libs/jszip")) {
return "jszip"
} else if (isIn("node_modules/@material/material-color-utilities")) {
return "material-color-utilities"
} else {
// Put all translations into "translation-code"
// Almost like in Rollup example: https://rollupjs.org/guide/en/#outputmanualchunks
// This groups chunks but does not rename them for some reason so we do chunkFileNames below
const match = /.*[\\|\/]translations[\\|\/](\w+)+\.ts/.exec(moduleId)
if (match) {
const language = match[1]
return "translation-" + language
} else if (isIn(`src/mail-app`) || isIn(`src/calendar-app`)) {
return "main"
}
}
}
function pushToMapEntry(map, key, value) {
let entry = []
if (map.has(key)) {
entry = map.get(key)
}
entry.push(value)
map.set(key, entry)
}
/**
* Creates a plugin which checks that all imports satisfy the rules that are defined in {@link allowedImports}.
*/
export function bundleDependencyCheckPlugin() {
const illegalImports = new Map()
const staticLangImports = new Map()
const unknownChunks = []
const reportErrors = () => {
let shouldThrow = false
if (illegalImports.size > 0) {
console.log("\nIllegal imports:")
shouldThrow = true
for (const [importer, importees] of Array.from(illegalImports.entries()).filter(([_, importees]) => importees.length > 0)) {
console.log(`\n in ${importer}:`)
for (const importee of importees) {
console.log("\t", importee)
}
}
}
if (staticLangImports.size > 0) {
console.log(shouldThrow ? "\n" : "", "Illegal static translation file dependencies:")
shouldThrow = true
for (const [importer, importees] of Array.from(staticLangImports.entries()).filter(([_, importees]) => importees.length > 0)) {
console.log(`\n in ${importer}:`)
for (const importee of importees) {
console.log("\t", importee)
}
}
}
if (unknownChunks.length > 0) {
console.log(shouldThrow ? "\n" : "", "Unknown chunks:")
shouldThrow = true
for (const unknownChunk of unknownChunks) {
console.log("\t", unknownChunk)
}
}
if (shouldThrow) throw new Error("fix illegal imports or unknown chunks (see above) and rerun")
}
return {
name: "bundle-dependency-check",
generateBundle(outOpts, bundle) {
// retrieves getModule function from plugin context.
const getModuleInfo = this.getModuleInfo.bind(this)
for (const chunk of Object.values(bundle)) {
// https://www.rollupjs.org/plugin-development/#generatebundle
if (chunk.type === "asset") continue
if (!chunk || !chunk.modules) {
continue
}
for (const moduleId of Object.keys(chunk.modules)) {
// Its a translation file and they are in their own chunks. We can skip further checks.
if (moduleId.includes(path.normalize("src/mail-app/translations"))) {
continue
}
const ownChunk = getChunkName(moduleId, { getModuleInfo })
if (!allowedImports[ownChunk]) {
unknownChunks.push(`${ownChunk} of ${moduleId}`)
}
for (const importedId of getModuleInfo(moduleId).importedIds) {
// static dependencies on translation files are not allowed
if (importedId.includes(path.normalize("src/mail-app/translations"))) {
pushToMapEntry(staticLangImports, moduleId, importedId)
}
const importedChunk = getChunkName(importedId, { getModuleInfo })
if (!allowedImports[importedChunk]) {
unknownChunks.push(`${importedChunk} of ${importedId}`)
}
if (ownChunk !== importedChunk && !allowedImports[ownChunk]?.includes(importedChunk)) {
pushToMapEntry(illegalImports, `${moduleId} [${ownChunk}]`, `${importedId} [${importedChunk}]`)
}
}
}
}
reportErrors()
},
}
}
Reference in a new issue View git blame Copy permalink