add fingerprint for app (#80)

ZhangYingchun-OPPO · web-flow · commit a29a9eb7c364 · 2024-12-10T14:15:42.000+08:00
* feat: add fingerprint for app

Signed-off-by: Yingchun &lt;zhangyingchun@oppo.com&gt;

* fix: validate router key (part of widget directory in compiling)

Signed-off-by: Yingchun &lt;zhangyingchun@oppo.com&gt;

---------

Signed-off-by: Yingchun &lt;zhangyingchun@oppo.com&gt;
diff --git a/packages/hap-packager/src/common/constant.js b/packages/hap-packager/src/common/constant.js
@@ -27,6 +27,16 @@ const COMPRESS_OPTS = {
   }
 }
 
+const LOADER_PATH_APP = {
+  path: '/app-loader.js',
+  type: ''
+}
+
+const LOADER_PATH_DEVICETYPE = {
+  path: '/device-type-loader.js',
+  type: ''
+}
+
 const LOADER_PATH_UX = {
   path: '/ux-loader.js',
   type: 'ux'
@@ -75,6 +85,8 @@ export {
   FULL_PKG_SIZE,
   COMPRESS_OPTS,
   BUILD_INFO_FILE,
+  LOADER_PATH_DEVICETYPE,
+  LOADER_PATH_APP,
   LOADER_PATH_UX,
   LOADER_PATH_STYLE,
   LOADER_PATH_TEMPLATE,
diff --git a/packages/hap-packager/src/plugins/widget-fingerprint-plugin.js b/packages/hap-packager/src/plugins/widget-fingerprint-plugin.js
@@ -6,7 +6,12 @@
 import fs from 'fs-extra'
 import path from 'path'
 import { calcDataDigest, getLastLoaderPath } from '../common/utils'
-import { LOADER_INFO_LIST, LOADER_PATH_UX } from '../common/constant'
+import {
+  LOADER_INFO_LIST,
+  LOADER_PATH_UX,
+  LOADER_PATH_APP,
+  LOADER_PATH_DEVICETYPE
+} from '../common/constant'
 
 const MANIFEST_PATH = 'manifest.json'
 
@@ -24,6 +29,10 @@ const EXCLUDE_FILE_EXTS = [
   ''
 ] // .gitignore .DS_Store
 
+const EXCLUDE_FILES = ['manifest.json', 'sitemap.json']
+
+const APP = 'app'
+
 /**
  * Generate a fingerprint string for a widget, based on the source code and config of the widget.
  * The fingerprint can be used to detect whether any changes on the widget.
@@ -56,67 +65,108 @@ class WidgetFingerprintPlugin {
       }
       const widgets = options.widgets || {}
       const widgetNameKeyMap = {}
-      const widgetEntries = Object.keys(widgets).map((key) => {
+      const widgetKeys = Object.keys(widgets) || {}
+      const widgetEntries = widgetKeys.map((key) => {
         const widget = widgets[key]
         const name = path.join(key, widget.component)
         widgetNameKeyMap[name] = key
         return name
       })
+      const allAssetsDigestMap = this.calculateAllAssetsDigest(pathSrc, pathSrc, {}, widgetKeys)
+      const appDigestMap = {}
       for (const chunk of compilation.chunks) {
         const chunkName = chunk.name
         if (widgetEntries.indexOf(chunkName) >= 0) {
           // widget chunk
-          const widgetKey = widgetNameKeyMap[chunkName]
           const widgetDigestMap = {}
-          const arr = []
-          for (const module of compilation.chunkGraph.getChunkModules(chunk)) {
-            const { _source, rawRequest, request } = module
-            arr.push(rawRequest)
-            if (!request) {
-              continue
-            }
-            const reqPath = request.replace(/\\/g, '/')
-            const lastLoaderPath = getLastLoaderPath(reqPath)
-            if (lastLoaderPath === LOADER_PATH_UX.path) {
-              // skip ux-loader.js
-              continue
-            }
-            const { absPath } = this.parseABSPath(reqPath, pathSrc)
-            const { _valueAsString, _valueAsBuffer } = _source || {}
-            const sourceValueStr = _valueAsString || _valueAsBuffer?.toString() || ''
-            let digestStr = ''
-            if (sourceValueStr !== '') {
-              const digest = calcDataDigest(Buffer.from(sourceValueStr, 'utf-8'))
-              digestStr = digest.toString('hex')
-            }
-            // module digest
-            widgetDigestMap[absPath] = digestStr
-          }
-          // assets digests
-          const assetsDigestMap = this.calculateAssetsDigest(path.join(pathSrc, widgetKey), pathSrc)
-          Object.assign(widgetDigestMap, assetsDigestMap)
-
-          // widget manifest digest
-          const manifestDigest = this.getManifestDigest(widgetKey, manifestContent)
-          widgetDigestMap[MANIFEST_PATH] = manifestDigest
-
-          const orderK = Object.keys(widgetDigestMap).sort()
-          let contentStr = '' // ordered path & digest string
-          orderK.forEach((filePath) => {
-            contentStr += `${filePath}:${widgetDigestMap[filePath]};`
-          })
-          // generate widget digest, save it in compilation
-          const widgetDigest = calcDataDigest(Buffer.from(contentStr, 'utf-8')).toString('hex')
-          const { _widgetDigestMap = {} } = compilation
-          _widgetDigestMap[`widget:${widgetKey}`] = widgetDigest
-          if (!compilation._widgetDigestMap) {
-            compilation._widgetDigestMap = _widgetDigestMap
-          }
+          this.getModuleDigestFromChunk(compilation, chunk, widgetDigestMap, pathSrc)
+          const widgetKey = widgetNameKeyMap[chunkName]
+          this.updateDigest(
+            compilation,
+            widgetKey,
+            widgetDigestMap,
+            allAssetsDigestMap,
+            manifestContent
+          )
+        } else {
+          // appDigestMap
+          this.getModuleDigestFromChunk(compilation, chunk, appDigestMap, pathSrc)
         }
       }
+      this.updateDigest(compilation, APP, appDigestMap, allAssetsDigestMap, manifestContent)
     })
   }
 
+  /**
+   * combine assets and manifest digests, save result on compilation
+   * @param {*} compilation
+   * @param {*} key app or widgets key
+   * @param {*} digestMap all digest for app & widgets
+   * @param {*} allAssetsDigestMap all assets digets
+   * @param {*} manifestContent manifest conentent
+   */
+  updateDigest(compilation, key, digestMap, allAssetsDigestMap, manifestContent) {
+    // assets digest
+    const assetsDigestMap = allAssetsDigestMap[key] || {}
+    Object.assign(digestMap, assetsDigestMap)
+    // manifest digest
+    digestMap[MANIFEST_PATH] = this.getManifestDigest(key, manifestContent)
+
+    const orderK = Object.keys(digestMap).sort()
+    let contentStr = '' // ordered path & digest string
+    orderK.forEach((filePath) => {
+      contentStr += `${filePath}:${digestMap[filePath]};`
+    })
+    // generate widget digest, save it in compilation
+    const digest = calcDataDigest(Buffer.from(contentStr, 'utf-8')).toString('hex')
+
+    const { _widgetDigestMap = {} } = compilation
+    if (key === APP) {
+      _widgetDigestMap[`app:${key}`] = digest
+    } else {
+      _widgetDigestMap[`widget:${key}`] = digest
+    }
+    if (!compilation._widgetDigestMap) {
+      compilation._widgetDigestMap = _widgetDigestMap
+    }
+  }
+
+  /**
+   * get all module digests in chunk
+   * @param {*} compilation
+   * @param {*} chunk
+   * @param {*} moduleDigestMap
+   * @param {*} pathSrc
+   */
+  getModuleDigestFromChunk(compilation, chunk, moduleDigestMap, pathSrc) {
+    for (const module of compilation.chunkGraph.getChunkModules(chunk)) {
+      const { _source, request } = module
+      if (!request) {
+        continue
+      }
+      const reqPath = request.replace(/\\/g, '/')
+      const lastLoaderPath = getLastLoaderPath(reqPath)
+      if (
+        lastLoaderPath === LOADER_PATH_UX.path ||
+        lastLoaderPath === LOADER_PATH_APP.path ||
+        lastLoaderPath === LOADER_PATH_DEVICETYPE.path
+      ) {
+        // skip
+        continue
+      }
+      const { absPath } = this.parseABSPath(reqPath, pathSrc)
+      const { _valueAsString, _valueAsBuffer } = _source || {}
+      const sourceValueStr = _valueAsString || _valueAsBuffer?.toString() || ''
+      let digestStr = ''
+      if (sourceValueStr !== '') {
+        const digest = calcDataDigest(Buffer.from(sourceValueStr, 'utf-8'))
+        digestStr = digest.toString('hex')
+      }
+      // module digest
+      moduleDigestMap[absPath] = digestStr
+    }
+  }
+
   /**
    * parse absolute path based by project src
    * @param {*} reqPath
@@ -147,24 +197,32 @@ class WidgetFingerprintPlugin {
   }
 
   /**
-   * 返回与当前卡片相关的 manifest 配置摘要
-   * @param string widgetKey
+   * 返回与当前app或widget相关的 manifest 配置摘要
+   * @param string key
    * @param string manifestContent
    */
-  getManifestDigest(widgetKey, manifestContent) {
-    if (!widgetKey || !manifestContent) {
+  getManifestDigest(key, manifestContent) {
+    if (!key || !manifestContent) {
       return new Date().getTime()
     }
     const manifestJsonNew = JSON.parse(manifestContent)
     manifestJsonNew.versionName = ''
     manifestJsonNew.versionCode = ''
-    manifestJsonNew.router.entry = ''
-    if (manifestJsonNew.router.pages) {
-      manifestJsonNew.router.pages = ''
-    }
-    manifestJsonNew.router.widgets = {
-      [widgetKey]: manifestJsonNew.router.widgets[widgetKey]
+    manifestJsonNew['template/official'] = ''
+    if (key === APP) {
+      if (manifestJsonNew.router.widgets) {
+        manifestJsonNew.router.widgets = ''
+      }
+    } else {
+      manifestJsonNew.router.entry = ''
+      if (manifestJsonNew.router.pages) {
+        manifestJsonNew.router.pages = ''
+      }
+      manifestJsonNew.router.widgets = {
+        [key]: manifestJsonNew.router.widgets[key]
+      }
     }
+
     const manifestJsonNewStr = JSON.stringify(manifestJsonNew)
     const digest = calcDataDigest(Buffer.from(manifestJsonNewStr, 'utf-8')).toString('hex')
     return digest
@@ -176,20 +234,38 @@ class WidgetFingerprintPlugin {
    * @param {string[]} allFiles
    * @returns {Object} relative file path and its digest
    */
-  calculateAssetsDigest(dir, basePath, assetsDigestMap = {}) {
+  calculateAllAssetsDigest(dir, basePath, assetsDigestMap, widgetKeys) {
     const files = fs.readdirSync(dir)
     for (let i = 0; i < files.length; i++) {
-      let name = path.join(dir, files[i])
-      if (fs.statSync(name).isDirectory()) {
-        this.calculateAssetsDigest(name, basePath, assetsDigestMap)
+      let fileName = path.join(dir, files[i])
+      if (fs.statSync(fileName).isDirectory()) {
+        // directory
+        this.calculateAllAssetsDigest(fileName, basePath, assetsDigestMap, widgetKeys)
       } else {
-        const ext = path.extname(name)
+        // file
+        const ext = path.extname(fileName)
         if (EXCLUDE_FILE_EXTS.includes(ext)) {
           continue
         }
-        const digest = calcDataDigest(fs.readFileSync(name)).toString('hex')
-        const relativePath = path.relative(basePath, name)
-        assetsDigestMap[relativePath] = digest
+        const relativePath = path.relative(basePath, fileName)
+        if (EXCLUDE_FILES.includes(relativePath)) {
+          continue
+        }
+        const digest = calcDataDigest(fs.readFileSync(fileName)).toString('hex')
+        const widgetKey = widgetKeys.find((item) => relativePath.startsWith(item + '/'))
+        if (widgetKey) {
+          // widget
+          if (!assetsDigestMap[widgetKey]) {
+            assetsDigestMap[widgetKey] = {}
+          }
+          assetsDigestMap[widgetKey][relativePath] = digest
+        } else {
+          // app
+          if (!assetsDigestMap[APP]) {
+            assetsDigestMap[APP] = {}
+          }
+          assetsDigestMap[APP][relativePath] = digest
+        }
       }
     }
     return assetsDigestMap
diff --git a/packages/hap-packager/src/plugins/zip-plugin.js b/packages/hap-packager/src/plugins/zip-plugin.js
@@ -372,7 +372,7 @@ ZipPlugin.prototype.apply = function (compiler) {
 
     const { _widgetDigestMap } = stats.compilation
     if (_widgetDigestMap && Object.keys(_widgetDigestMap)?.length) {
-      console.log('widget fingerprint:', _widgetDigestMap)
+      console.log('fingerprint:', _widgetDigestMap)
     }
 
     // 遍历文件分配文件资源到每个package里面, 包括digest, file hash
diff --git a/packages/hap-toolkit/src/utils.js b/packages/hap-toolkit/src/utils.js
@@ -8,6 +8,26 @@ import { colorconsole, compileOptionsObject } from '@hap-toolkit/shared-utils'
 import { ENTRY_TYPE } from '@hap-toolkit/compiler'
 import { resolveFile } from '@hap-toolkit/packager'
 
+const NOT_ALLOW_CHARS = [
+  '@',
+  '$',
+  '.',
+  '&',
+  '+',
+  '(',
+  ')',
+  ' ',
+  '-',
+  '\\',
+  '//',
+  '?',
+  ':',
+  '|',
+  '<',
+  '>',
+  '='
+]
+
 /**
  * 提取其中的应用，页面，worker的脚本文件
  * @return {Array}
@@ -66,6 +86,15 @@ export function resolveEntries(manifest, basedir, cwd) {
       const conf = confs[routePath]
       const entryKey = path.join(routePath, conf.component)
       const filepath = resolveFile(path.join(basedir, entryKey))
+      if (type === 'card') {
+        for (let ch of NOT_ALLOW_CHARS) {
+          if (routePath.indexOf(ch) > -1) {
+            colorconsole.throw(
+              `编译失败：manifest.json中卡片router配置的key不能包含 字母、数字、/、_ 以外的特殊字符：${entryKey}`
+            )
+          }
+        }
+      }
 
       if (!filepath) {
         colorconsole.throw(`编译失败：请确认manifest.json中配置的文件路径存在：${entryKey}`)

Original file line number	Diff line number	Diff line change
`@@ -372,7 +372,7 @@ ZipPlugin.prototype.apply = function (compiler) {`
`372`	`372`
`373`	`373`	`const { _widgetDigestMap } = stats.compilation`
`374`	`374`	`if (_widgetDigestMap && Object.keys(_widgetDigestMap)?.length) {`
`375`		`- console.log('widget fingerprint:', _widgetDigestMap)`
	`375`	`+ console.log('fingerprint:', _widgetDigestMap)`
`376`	`376`	`}`
`377`	`377`
`378`	`378`	`// 遍历文件分配文件资源到每个package里面, 包括digest, file hash`