Add node end-to-end tests for bundles

Author: mattiasw

.eslintignore

@@ -1,2 +1,2 @@
-node_modules/**/*
+node_modules
 dist

.github/workflows/nodejs.yml

@@ -25,11 +25,12 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     - run: npm run lint
-    - run: npm test
+    - run: npm run test
+    - run: npm run test:build
       env:
         CI: true
     - run: npm run build
-  package-ubuntu:
+  package-ubuntu-full:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -38,18 +39,11 @@ jobs:
       with:
         node-version: 10.x
     - run: npm ci
-    - name: Test npm package with minimal requirements
+    - name: Test npm package and custom builds with minimal requirements
       run: |
-        npm pack
-        PACKAGE="exifreader-$(node -p "require('./package.json').version").tgz"
-        mkdir my-project
-        cd my-project
         PATH=$(echo "$PATH" | sed -e 's/:\/usr\/local\/bin://'):/usr/local/bin/npm:/usr/local/bin/node
-        npm init -y
-        npm install ../$PACKAGE
-        node -p "const {writeFileSync} = require('fs'); const packageJson = require('./package.json'); packageJson.exifreader = {include: {jpeg: true, exif: true}}; writeFileSync('package.json', JSON.stringify(packageJson));"
-        npm rebuild exifreader
-  package-windows:
+        npm run test:build:custom
+  package-windows-basic:
     runs-on: windows-latest
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -7,3 +7,7 @@ test/cypress/videos
 .tags
 .tags1
 .vscode
+exifreader-*.tgz
+test/build/tmp
+test/fixtures/images/custom_*
+test/fixtures/outputs/custom_*

README.md

@@ -224,7 +224,8 @@ Possible modules to include or exclude:
 | `tiff`      | TIFF images.                                                   |
 | `png`       | PNG images.                                                    |
 | `heic`      | HEIC/HEIF images.                                              |
-| `file`      | JPEG image width, height etc.                                  |
+| `file`      | JPEG file details: image width, height etc.                    |
+| `png_file`  | PNG file details: image width, height etc.                     |
 | `exif`      | Regular Exif tags. If excluded, will also exclude `thumbnail`. For TIFF files, excluding this will also exclude IPTC and XMP. |
 | `iptc`      | IPTC tags.                                                     |
 | `xmp`       | XMP tags.                                                      |

cypress.json

@@ -1,6 +1,6 @@
 {
     "baseUrl": "https://localhost:8080",
-    "fixturesFolder": "test/cypress/fixtures",
+    "fixturesFolder": "test/fixtures",
     "integrationFolder": "test/cypress/integration",
     "pluginsFile": "test/cypress/plugins/index.js",
     "screenshotsFolder": "test/cypress/screenshots",

dist/exif-reader.js

@@ -25,7 +25,7 @@ fs.readFile(filePath, function (error, data) {
     }
 
     try {
-        const tags = ExifReader.load(data.buffer);
+        const tags = ExifReader.load((new Uint8Array(data)).buffer);
 
         // The MakerNote tag can be really large. Remove it to lower memory
         // usage if you're parsing a lot of files and saving the tags.

dist/exif-reader.js.map

@@ -39,6 +39,7 @@
     "mocha": "^7.1.1",
     "npm-run-all": "^4.1.5",
     "nyc": "^14.1.1",
+    "rimraf": "^3.0.2",
     "string-replace-loader": "^2.2.0",
     "webpack": "^4.42.0",
     "webpack-cli": "^3.3.6",
@@ -52,7 +53,11 @@
     "precommit": "npm-run-all lint test",
     "start": "webpack-dev-server",
     "test": "cross-env BABEL_ENV=test mocha --require @babel/register --recursive \"test/unit/\"",
+    "test:build": "mocha test/build/test.js",
+    "test:build:custom": "mocha test/build/test-custom.js",
+    "test:build:update": "node test/build/update.js",
     "test:e2e": "cypress run",
+    "test:all": "npm-run-all test test:e2e test:build test:build:custom",
     "postinstall": "node bin/build.js --only-with-config"
   },
   "nyc": {

examples/nodejs/exif.js

@@ -4,6 +4,7 @@
 
 export default {
     USE_FILE: true,
+    USE_PNG_FILE: true,
     USE_EXIF: true,
     USE_IPTC: true,
     USE_XMP: true,

package-lock.json

@@ -119,7 +119,7 @@ export function loadView(dataView, options = {expanded: false}) {
         }
     }
 
-    if (Constants.USE_PNG && hasPngFileData(pngHeaderOffset)) {
+    if (Constants.USE_PNG && Constants.USE_PNG_FILE && hasPngFileData(pngHeaderOffset)) {
         foundMetaData = true;
         const readTags = PngFileTags.read(dataView, pngHeaderOffset);
         if (options.expanded) {

package.json

@@ -28,10 +28,11 @@ function findPngOffsets(dataView) {
     const offsets = {
         hasAppMarkers: false
     };
+
     let offset = PNG_ID.length;
 
     while (offset + PNG_CHUNK_LENGTH_SIZE + PNG_CHUNK_TYPE_SIZE <= dataView.byteLength) {
-        if (isPngImageHeaderChunk(dataView, offset)) {
+        if (Constants.USE_PNG_FILE && isPngImageHeaderChunk(dataView, offset)) {
             offsets.hasAppMarkers = true;
             offsets.pngHeaderOffset = offset + PNG_CHUNK_DATA_OFFSET;
         } else if (Constants.USE_XMP && isPngXmpChunk(dataView, offset)) {

src/constants.js

@@ -0,0 +1,123 @@
+[
+    {
+        "id": "everything",
+        "config": {
+            "include": {
+                "file": true,
+                "png_file": true,
+                "exif": true,
+                "iptc": true,
+                "xmp": true,
+                "icc": true,
+                "thumbnail": true,
+                "tiff": true,
+                "jpeg": true,
+                "png": true,
+                "heic": true
+            }
+        }
+    },
+    {
+        "id": "full-tiff",
+        "config": {
+            "include": {
+                "tiff": true,
+                "exif": true,
+                "iptc": true,
+                "xmp": true
+            }
+        }
+    },
+    {
+        "id": "partial-tiff",
+        "config": {
+            "include": {
+                "tiff": true,
+                "exif": ["DateTime", "ExposureProgram", "DateTimeOriginal", "ComponentsConfiguration", "Flash", "GPSLatitude", "GPSLatitudeRef"],
+                "iptc": ["File Format", "Coded Character Set", "By-line", "Keywords"]
+            }
+        }
+    },
+    {
+        "id": "full-jpeg",
+        "config": {
+            "include": {
+                "jpeg": true,
+                "file": true,
+                "exif": true,
+                "iptc": true,
+                "xmp": true,
+                "icc": true,
+                "thumbnail": true
+            }
+        }
+    },
+    {
+        "id": "partial-jpeg",
+        "config": {
+            "include": {
+                "jpeg": true,
+                "exif": ["DateTime", "ExposureProgram", "DateTimeOriginal", "ComponentsConfiguration", "Flash", "GPSLatitude", "GPSLatitudeRef"],
+                "iptc": ["File Format", "Coded Character Set", "By-line", "Keywords"]
+            }
+        }
+    },
+    {
+        "id": "full-png",
+        "config": {
+            "include": {
+                "png": true,
+                "png_file": true,
+                "xmp": true
+            }
+        }
+    },
+    {
+        "id": "small-png",
+        "config": {
+            "include": {
+                "png": true,
+                "xmp": true
+            }
+        }
+    },
+    {
+        "id": "full-heic",
+        "config": {
+            "include": {
+                "heic": true,
+                "exif": true
+            }
+        }
+    },
+    {
+        "id": "partial-heic",
+        "config": {
+            "include": {
+                "heic": true,
+                "exif": ["DateTime", "ExposureProgram", "DateTimeOriginal", "ComponentsConfiguration", "Flash", "GPSLatitude", "GPSLatitudeRef"]
+            }
+        }
+    },
+    {
+        "id": "tiff-png",
+        "config": {
+            "include": {
+                "tiff": true,
+                "png": true,
+                "exif": true,
+                "xmp": true
+            }
+        }
+    },
+    {
+        "id": "jpeg-heic",
+        "config": {
+            "include": {
+                "jpeg": true,
+                "heic": true,
+                "exif": true
+            }
+        }
+    }
+]

src/exif-reader.js

@@ -0,0 +1,32 @@
+const path = require('path');
+const fs = require('fs');
+
+module.exports = {
+    parse
+};
+
+function parse(imagePath, libraryDir = '../..') {
+    const exifReaderPath = require.resolve(path.join(libraryDir, 'dist/exif-reader'));
+    delete require.cache[exifReaderPath];
+    const ExifReader = require(exifReaderPath);
+    const data = (new Uint8Array(fs.readFileSync(imagePath))).buffer;
+
+    try {
+        const result = {
+            combined: ExifReader.load(data),
+            expanded: ExifReader.load(data, {expanded: true})
+        };
+        if (result.combined.Thumbnail && result.combined.Thumbnail.image) {
+            result.combined.Thumbnail.image = (new Uint8Array(result.combined.Thumbnail.image)).map((char) => Number(char)).toString();
+        }
+        if (result.expanded.Thumbnail && result.expanded.Thumbnail.image) {
+            result.expanded.Thumbnail.image = (new Uint8Array(result.expanded.Thumbnail.image)).map((char) => Number(char)).toString();
+        }
+        return result;
+    } catch (error) {
+        if (error instanceof ExifReader.errors.MetadataMissingError) {
+            return 'No Exif data found';
+        }
+        return error.toString();
+    }
+}