@expo/fingerprint 0.4.1 → 0.5.0

package/e2e/__tests__/managed-test.ts

@@ -1,165 +0,0 @@
-import spawnAsync from '@expo/spawn-async';
-import fs from 'fs/promises';
-import path from 'path';
-import rimraf from 'rimraf';
-
-import {
-  createFingerprintAsync,
-  createProjectHashAsync,
-  diffFingerprintChangesAsync,
-} from '../../src/Fingerprint';
-import { normalizeOptionsAsync } from '../../src/Options';
-import { getHashSourcesAsync } from '../../src/sourcer/Sourcer';
-
-jest.mock('../../src/sourcer/ExpoConfigLoader', () => ({
-  // Mock the getExpoConfigLoaderPath to use the built version rather than the typescript version from src
-  getExpoConfigLoaderPath: jest.fn(() =>
-    path.resolve(__dirname, '..', '..', 'build', 'sourcer', 'ExpoConfigLoader.js')
-  ),
-}));
-
-describe('managed project test', () => {
-  jest.setTimeout(600000);
-  const tmpDir = require('temp-dir');
-  const projectName = 'fingerprint-e2e-managed';
-  const projectRoot = path.join(tmpDir, projectName);
-
-  beforeAll(async () => {
-    rimraf.sync(projectRoot);
-    await spawnAsync('bunx', ['create-expo-app', '-t', 'blank', projectName], {
-      stdio: 'inherit',
-      cwd: tmpDir,
-    });
-  });
-
-  afterAll(async () => {
-    rimraf.sync(projectRoot);
-  });
-
-  it('should have same hash after adding js only library', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-    await spawnAsync('npx', ['expo', 'install', '@react-navigation/core'], {
-      stdio: 'ignore',
-      cwd: projectRoot,
-    });
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).toBe(hash2);
-  });
-
-  it('should have same hash after updating js code', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-
-    const jsPath = path.join(projectRoot, 'App.js');
-    const js = await fs.readFile(jsPath, 'utf8');
-    await fs.writeFile(jsPath, `${js}\n// adding comments`);
-
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).toBe(hash2);
-  });
-
-  it('should have different hash after adding native library', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-    await spawnAsync('npx', ['expo', 'install', 'expo-updates'], {
-      stdio: 'ignore',
-      cwd: projectRoot,
-    });
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).not.toBe(hash2);
-  });
-
-  it('should have different hash after updating `jsEngine`', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-
-    const configPath = path.join(projectRoot, 'app.json');
-    const config = JSON.parse(await fs.readFile(configPath, 'utf8'));
-    config.expo.jsEngine = 'hermes';
-    await fs.writeFile(configPath, JSON.stringify(config, null, 2));
-
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).not.toBe(hash2);
-  });
-
-  it('should have different hash after updating icon file', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-
-    const iconPath = path.join(projectRoot, 'assets', 'icon.png');
-    await fs.writeFile(iconPath, '');
-
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).not.toBe(hash2);
-  });
-
-  it('should have different hash after adding js only config-plugin', async () => {
-    const hash = await createProjectHashAsync(projectRoot);
-    await spawnAsync('npx', ['expo', 'install', 'expo-build-properties'], {
-      stdio: 'ignore',
-      cwd: projectRoot,
-    });
-    const hash2 = await createProjectHashAsync(projectRoot);
-    expect(hash).not.toBe(hash2);
-  });
-
-  it('diffFingerprintChangesAsync - should return diff after adding native library', async () => {
-    const fingerprint = await createFingerprintAsync(projectRoot);
-    await spawnAsync('bun', ['install', '--save', '@react-native-community/netinfo@9.3.7'], {
-      stdio: 'ignore',
-      cwd: projectRoot,
-    });
-    const diff = await diffFingerprintChangesAsync(fingerprint, projectRoot);
-    expect(diff).toMatchInlineSnapshot(`
-      [
-        {
-          "filePath": "node_modules/@react-native-community/netinfo",
-          "hash": "8a255b59e10118a8cf5c1660d12d6b2e9293ed5c",
-          "reasons": [
-            "bareRncliAutolinking",
-          ],
-          "type": "dir",
-        },
-        {
-          "contents": "{"@react-native-community/netinfo":{"root":"node_modules/@react-native-community/netinfo","name":"@react-native-community/netinfo","platforms":{"ios":{"podspecPath":"node_modules/@react-native-community/netinfo/react-native-netinfo.podspec","configurations":[],"scriptPhases":[]},"android":{"sourceDir":"node_modules/@react-native-community/netinfo/android","packageImportPath":"import com.reactnativecommunity.netinfo.NetInfoPackage;","packageInstance":"new NetInfoPackage()","buildTypes":[],"componentDescriptors":[],"cmakeListsPath":"node_modules/@react-native-community/netinfo/android/build/generated/source/codegen/jni/CMakeLists.txt"}}},"expo":{"root":"node_modules/expo","name":"expo","platforms":{"ios":{"podspecPath":"node_modules/expo/Expo.podspec","configurations":[],"scriptPhases":[]},"android":{"sourceDir":"node_modules/expo/android","packageImportPath":"import expo.modules.ExpoModulesPackage;","packageInstance":"new ExpoModulesPackage()","buildTypes":[],"componentDescriptors":[],"cmakeListsPath":"node_modules/expo/android/build/generated/source/codegen/jni/CMakeLists.txt"}}}}",
-          "hash": "ac75722bd87eb0189440be83faa2249079da5839",
-          "id": "rncliAutolinkingConfig",
-          "reasons": [
-            "bareRncliAutolinking",
-          ],
-          "type": "contents",
-        },
-      ]
-    `);
-  });
-});
-
-describe(`getHashSourcesAsync - managed project`, () => {
-  jest.setTimeout(600000);
-  const tmpDir = require('temp-dir');
-  const projectName = 'fingerprint-e2e-managed';
-  const projectRoot = path.join(tmpDir, projectName);
-
-  beforeAll(async () => {
-    rimraf.sync(projectRoot);
-    // Pin the SDK version to prevent the latest version breaking snapshots
-    await spawnAsync('bunx', ['create-expo-app', '-t', 'blank@sdk-49', projectName], {
-      stdio: 'inherit',
-      cwd: tmpDir,
-    });
-
-    // Pin the `expo` package version to prevent the latest version breaking snapshots
-    await spawnAsync('bun', ['install', '--save', 'expo@49.0.16'], {
-      stdio: 'ignore',
-      cwd: projectRoot,
-    });
-  });
-
-  afterAll(async () => {
-    rimraf.sync(projectRoot);
-  });
-
-  it('should match snapshot', async () => {
-    const sources = await getHashSourcesAsync(
-      projectRoot,
-      await normalizeOptionsAsync(projectRoot)
-    );
-    expect(sources).toMatchSnapshot();
-  });
-});

package/e2e/jest.config.js

@@ -1,11 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  testEnvironment: 'node',
-  preset: 'ts-jest',
-  testRegex: '/__tests__/.*(test|spec)\\.[jt]sx?$',
-  watchPlugins: ['jest-watch-typeahead/filename', 'jest-watch-typeahead/testname'],
-  rootDir: path.resolve(__dirname),
-  displayName: require('../package').name,
-  roots: ['.'],
-};

package/jest.config.js

@@ -1,10 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  testEnvironment: 'node',
-  testRegex: '/__tests__/.*(test|spec)\\.[jt]sx?$',
-  watchPlugins: ['jest-watch-typeahead/filename', 'jest-watch-typeahead/testname'],
-  rootDir: path.resolve(__dirname),
-  displayName: require('./package').name,
-  roots: ['__mocks__', 'src'],
-};

package/scripts/createFixture.ts

@@ -1,81 +0,0 @@
-/**
- * Tool to generate vol JSON fixture from a project.
- *
- * Usage: npx ts-node scripts/createFixture /path/to/app /path/to/output.json
- */
-import realFS from 'fs';
-import glob from 'glob';
-import { fs, vol } from 'memfs';
-import path from 'path';
-
-function globAsync(pattern: string, options: Parameters<typeof glob>[1]): Promise<string[]> {
-  return new Promise((resolve, reject) => {
-    glob(pattern, options, (err, matches) => {
-      if (err != null) {
-        reject(err);
-      } else {
-        resolve(matches);
-      }
-    });
-  });
-}
-
-async function createFixtureAsync(targetDir: string, outputFile: string) {
-  const files = await globAsync('**/*', {
-    cwd: targetDir,
-    ignore: [
-      // binary files
-      '**/*.{jpg,png}',
-
-      // lock files
-      '**/*.lock',
-
-      // node files
-      '**/node_modules/**',
-
-      // generated files
-      '**/build/**',
-
-      // ios files
-      'ios/Pods/**',
-      'vendor/**',
-      '**/xcuserdata/**',
-      '**/*.xcassets/**',
-      '**/IDEWorkspaceChecks.plist',
-
-      // android files
-      '**/*.jar',
-      '**/*.keystore',
-      '**/gradlew',
-      '**/gradlew.bat',
-      '**/gradle/wrapper/**',
-    ],
-    nodir: true,
-  });
-  for (const file of files) {
-    const content = realFS.readFileSync(path.join(targetDir, file), 'utf8');
-    fs.mkdirSync(path.join('/', path.dirname(file)), { recursive: true });
-    fs.writeFileSync(path.join('/', file), content);
-  }
-  const resultJSON: Record<string, string | null> = {};
-  for (const [key, value] of Object.entries(vol.toJSON())) {
-    resultJSON[path.join('/app', path.relative('/', key))] = value;
-  }
-  realFS.writeFileSync(outputFile, JSON.stringify(resultJSON, null, 2));
-}
-
-(async () => {
-  if (process.argv.length !== 4) {
-    console.log(`Usage: ${path.basename(process.argv[1])} targetDir outputFile`);
-    process.exit(1);
-  }
-  const targetDir = process.argv[2];
-  const outputFile = process.argv[3];
-
-  try {
-    await createFixtureAsync(targetDir, outputFile);
-  } catch (e) {
-    console.error('Uncaught Error', e);
-    process.exit(1);
-  }
-})();

package/src/Dedup.ts

@@ -1,97 +0,0 @@
-import assert from 'assert';
-import path from 'path';
-
-import type { HashSource, HashSourceDir, HashSourceFile } from './Fingerprint.types';
-
-const debug = require('debug')('expo:fingerprint:Dedup');
-
-/**
- * Strip duplicated sources, mainly for duplicated file or dir
- */
-export function dedupSources(sources: HashSource[], projectRoot: string): HashSource[] {
-  const newSources: HashSource[] = [];
-  for (const source of sources) {
-    const [duplicatedItemIndex, shouldSwapSource] = findDuplicatedSourceIndex(
-      newSources,
-      source,
-      projectRoot
-    );
-    if (duplicatedItemIndex >= 0) {
-      const duplicatedItem = newSources[duplicatedItemIndex];
-      debug(`Skipping duplicated source: ${source}`);
-      if (shouldSwapSource) {
-        newSources[duplicatedItemIndex] = {
-          ...source,
-          reasons: [...source.reasons, ...duplicatedItem.reasons],
-        };
-      } else {
-        duplicatedItem.reasons.push(...source.reasons);
-      }
-    } else {
-      newSources.push(source);
-    }
-  }
-
-  return newSources;
-}
-
-/**
- * When two sources are duplicated, merge `src`'s reasons into `dst`
- */
-export function mergeSourceWithReasons(dst: HashSource, src: HashSource): HashSource {
-  return dst;
-}
-
-/**
- * Find the duplicated `source` in `newSources`
- * @return tuple of [duplicatedItemIndexInNewSources, shouldSwapSource]
- */
-function findDuplicatedSourceIndex(
-  newSources: HashSource[],
-  source: HashSource,
-  projectRoot: string
-): [number, boolean] {
-  let shouldSwapSource = false;
-  if (source.type === 'contents') {
-    return [
-      newSources.findIndex((item) => item.type === source.type && item.id === source.id) ?? null,
-      shouldSwapSource,
-    ];
-  }
-
-  for (const [index, existingSource] of newSources.entries()) {
-    if (existingSource.type === 'contents') {
-      continue;
-    }
-    if (isDescendant(source, existingSource, projectRoot)) {
-      return [index, shouldSwapSource];
-    }
-    // If the new source is ancestor of existing source, replace swap the existing source with the new source
-    if (isDescendant(existingSource, source, projectRoot)) {
-      shouldSwapSource = true;
-      return [index, shouldSwapSource];
-    }
-  }
-  return [-1, shouldSwapSource];
-}
-
-function isDescendant(
-  from: HashSourceDir | HashSourceFile,
-  to: HashSourceDir | HashSourceFile,
-  projectRoot: string
-): boolean {
-  if (from === to) {
-    return true;
-  }
-
-  const fromPath = path.join(projectRoot, from.filePath);
-  const toPath = path.join(projectRoot, to.filePath);
-  const result = path.relative(fromPath, toPath).match(/^[./\\/]*$/) != null;
-  if (result) {
-    assert(
-      !(to.type === 'file' && from.type === 'dir'),
-      `Unexpected case which a dir is a descendant of a file - from[${fromPath}] to[${toPath}]`
-    );
-  }
-  return result;
-}

package/src/Fingerprint.ts

@@ -1,60 +0,0 @@
-import { dedupSources } from './Dedup';
-import type { Fingerprint, FingerprintSource, Options } from './Fingerprint.types';
-import { normalizeOptionsAsync } from './Options';
-import { sortSources } from './Sort';
-import { createFingerprintFromSourcesAsync } from './hash/Hash';
-import { getHashSourcesAsync } from './sourcer/Sourcer';
-
-/**
- * Create a fingerprint from project
- */
-export async function createFingerprintAsync(
-  projectRoot: string,
-  options?: Options
-): Promise<Fingerprint> {
-  const opts = await normalizeOptionsAsync(projectRoot, options);
-  const sources = await getHashSourcesAsync(projectRoot, opts);
-  const normalizedSources = sortSources(dedupSources(sources, projectRoot));
-  const fingerprint = await createFingerprintFromSourcesAsync(normalizedSources, projectRoot, opts);
-  return fingerprint;
-}
-
-/**
- * Create a native hash value from project
- */
-export async function createProjectHashAsync(
-  projectRoot: string,
-  options?: Options
-): Promise<string> {
-  const fingerprint = await createFingerprintAsync(projectRoot, options);
-  return fingerprint.hash;
-}
-
-/**
- * Differentiate given `fingerprint` with the current project fingerprint state
- */
-export async function diffFingerprintChangesAsync(
-  fingerprint: Fingerprint,
-  projectRoot: string,
-  options?: Options
-): Promise<FingerprintSource[]> {
-  const newFingerprint = await createFingerprintAsync(projectRoot, options);
-  if (fingerprint.hash === newFingerprint.hash) {
-    return [];
-  }
-  return diffFingerprints(fingerprint, newFingerprint);
-}
-
-/**
- * Differentiate two fingerprints
- */
-export function diffFingerprints(
-  fingerprint1: Fingerprint,
-  fingerprint2: Fingerprint
-): FingerprintSource[] {
-  return fingerprint2.sources.filter((newItem) => {
-    return !fingerprint1.sources.find(
-      (item) => item.type === newItem.type && item.hash === newItem.hash
-    );
-  });
-}

package/src/Fingerprint.types.ts

@@ -1,110 +0,0 @@
-export type FingerprintSource = HashSource & {
-  /**
-   * Hash value of the `source`.
-   * If the source is excluding by `Options.dirExcludes`, the value will be null.
-   */
-  hash: string | null;
-};
-
-export interface Fingerprint {
-  /**
-   * Sources and their hash values to generate a fingerprint
-   */
-  sources: FingerprintSource[];
-
-  /**
-   * The final hash value of the whole fingerprint
-   */
-  hash: string;
-}
-
-export type Platform = 'android' | 'ios';
-
-export interface Options {
-  /**
-   * Only get native files from the given platforms. Default is `['android', 'ios']`.
-   */
-  platforms?: Platform[];
-
-  /**
-   * I/O concurrent limit. Default is the number of CPU core.
-   */
-  concurrentIoLimit?: number;
-
-  /**
-   * The algorithm passing to `crypto.createHash()`. Default is `'sha1'`.
-   */
-  hashAlgorithm?: string;
-
-  /**
-   * Excludes directories from hashing. This supported pattern is as `glob()`.
-   * Default is `['android/build', 'android/app/build', 'android/app/.cxx', 'ios/Pods']`.
-   * @deprecated Use `ignorePaths` instead.
-   */
-  dirExcludes?: string[];
-
-  /**
-   * Ignore files and directories from hashing. This supported pattern is as `glob()`.
-   *
-   * Please note that the pattern matching is slightly different from gitignore. For example, we don't support partial matching where `build` does not match `android/build`. You should use `'**' + '/build'` instead.
-   * @see [minimatch implementations](https://github.com/isaacs/minimatch#comparisons-to-other-fnmatchglob-implementations) for more reference.
-   *
-   * Besides this `ignorePaths`, fingerprint comes with implicit default ignorePaths defined in `Options.DEFAULT_IGNORE_PATHS`.
-   * If you want to override the default ignorePaths, use `!` prefix.
-   */
-  ignorePaths?: string[];
-
-  /**
-   * Additional sources for hashing.
-   */
-  extraSources?: HashSource[];
-}
-
-//#region internal types
-
-export interface NormalizedOptions extends Options {
-  platforms: NonNullable<Options['platforms']>;
-  concurrentIoLimit: NonNullable<Options['concurrentIoLimit']>;
-  hashAlgorithm: NonNullable<Options['hashAlgorithm']>;
-  ignorePaths: NonNullable<Options['ignorePaths']>;
-}
-
-export interface HashSourceFile {
-  type: 'file';
-  filePath: string;
-
-  /**
-   * Reasons of this source coming from
-   */
-  reasons: string[];
-}
-
-export interface HashSourceDir {
-  type: 'dir';
-  filePath: string;
-
-  /**
-   * Reasons of this source coming from
-   */
-  reasons: string[];
-}
-
-export interface HashSourceContents {
-  type: 'contents';
-  id: string;
-  contents: string | Buffer;
-
-  /**
-   * Reasons of this source coming from
-   */
-  reasons: string[];
-}
-
-export type HashSource = HashSourceFile | HashSourceDir | HashSourceContents;
-
-export interface HashResult {
-  id: string;
-  hex: string;
-}
-
-//#endregion

package/src/Options.ts

@@ -1,81 +0,0 @@
-import fs from 'fs/promises';
-import os from 'os';
-import path from 'path';
-
-import type { NormalizedOptions, Options } from './Fingerprint.types';
-
-export const FINGERPRINT_IGNORE_FILENAME = '.fingerprintignore';
-
-export const DEFAULT_IGNORE_PATHS = [
-  FINGERPRINT_IGNORE_FILENAME,
-  '**/android/build/**/*',
-  '**/android/app/build/**/*',
-  '**/android/app/.cxx/**/*',
-  '**/ios/Pods/**/*',
-
-  // Ignore all expo configs because we will read expo config in a HashSourceContents already
-  'app.config.ts',
-  'app.config.js',
-  'app.config.json',
-  'app.json',
-
-  // Ignore default javascript files when calling `getConfig()`
-  '**/node_modules/@babel/**/*',
-  '**/node_modules/@expo/**/*',
-  '**/node_modules/@jridgewell/**/*',
-  '**/node_modules/expo/config.js',
-  '**/node_modules/expo/config-plugins.js',
-  `**/node_modules/{${[
-    'debug',
-    'escape-string-regexp',
-    'getenv',
-    'graceful-fs',
-    'has-flag',
-    'imurmurhash',
-    'js-tokens',
-    'json5',
-    'lines-and-columns',
-    'require-from-string',
-    'resolve-from',
-    'signal-exit',
-    'sucrase',
-    'supports-color',
-    'ts-interface-checker',
-    'write-file-atomic',
-  ].join(',')}}/**/*`,
-];
-
-export async function normalizeOptionsAsync(
-  projectRoot: string,
-  options?: Options
-): Promise<NormalizedOptions> {
-  return {
-    ...options,
-    platforms: options?.platforms ?? ['android', 'ios'],
-    concurrentIoLimit: options?.concurrentIoLimit ?? os.cpus().length,
-    hashAlgorithm: options?.hashAlgorithm ?? 'sha1',
-    ignorePaths: await collectIgnorePathsAsync(projectRoot, options),
-  };
-}
-
-async function collectIgnorePathsAsync(projectRoot: string, options?: Options): Promise<string[]> {
-  const ignorePaths = [
-    ...DEFAULT_IGNORE_PATHS,
-    ...(options?.ignorePaths ?? []),
-    ...(options?.dirExcludes?.map((dirExclude) => `${dirExclude}/**/*`) ?? []),
-  ];
-
-  const fingerprintIgnorePath = path.join(projectRoot, FINGERPRINT_IGNORE_FILENAME);
-  try {
-    const fingerprintIgnore = await fs.readFile(fingerprintIgnorePath, 'utf8');
-    const fingerprintIgnoreLines = fingerprintIgnore.split('\n');
-    for (const line of fingerprintIgnoreLines) {
-      const trimmedLine = line.trim();
-      if (trimmedLine) {
-        ignorePaths.push(trimmedLine);
-      }
-    }
-  } catch {}
-
-  return ignorePaths;
-}

package/src/Sort.ts

@@ -1,22 +0,0 @@
-import type { HashSource } from './Fingerprint.types';
-
-export function sortSources<T extends HashSource>(sources: T[]): T[] {
-  const typeOrder = {
-    file: 0,
-    dir: 1,
-    contents: 2,
-  };
-  return sources.sort((a, b) => {
-    const typeResult = typeOrder[a.type] - typeOrder[b.type];
-    if (typeResult === 0) {
-      if (a.type === 'file' && b.type === 'file') {
-        return a.filePath.localeCompare(b.filePath);
-      } else if (a.type === 'dir' && b.type === 'dir') {
-        return a.filePath.localeCompare(b.filePath);
-      } else if (a.type === 'contents' && b.type === 'contents') {
-        return a.id.localeCompare(b.id);
-      }
-    }
-    return typeResult;
-  });
-}