@microsoft/power-apps-native-host 0.2.25 → 0.3.3

package/scripts/upgrade/runtime.js

@@ -6,16 +6,30 @@ const path = require('path');
 const { applyPatch, formatPatch, parsePatch, reversePatch } = require('diff');
 
 const HOST_PACKAGE = '@microsoft/power-apps-native-host';
-const TEMPLATE_VERSION_PATH = '.powerapps-native/version.json';
+const TEMPLATE_VERSION_PATH = 'app.json';
 const TSCONFIG_PATH = 'tsconfig.json';
+const GITIGNORE_PATH = '.gitignore';
+const GITIGNORE_START = '# POWER APPS MANAGED START - DO NOT REMOVE OR RENAME THE COMMENT';
+const GITIGNORE_END = '# POWER APPS MANAGED END - DO NOT REMOVE OR RENAME THE COMMENT';
 const TEMPLATE_MANAGED_PATHS = [
+  GITIGNORE_PATH,
   TEMPLATE_VERSION_PATH,
   'app.config.js',
+  'babel.config.js',
+  'metro.config.js',
   'package-lock.json',
   'package.json',
+  'power-apps-env.d.ts',
+  'tamagui.config.ts',
   TSCONFIG_PATH,
 ];
-const UNIFIED_PATCH_MANAGED_PATHS = ['app.config.js'];
+const UNIFIED_PATCH_MANAGED_PATHS = [
+  'app.config.js',
+  'babel.config.js',
+  'metro.config.js',
+  'power-apps-env.d.ts',
+  'tamagui.config.ts',
+];
 
 function isTemplateManagedPath(relativePath) {
   return TEMPLATE_MANAGED_PATHS.includes(relativePath);
@@ -151,10 +165,21 @@ function patchPackageJson(source, profile, hostVersion, transitions = null) {
   packageJson.dependencies ||= {};
   setManagedValues(packageJson, { expo: profile.expoVersion }, 'dependencies', changes);
   setManagedValues(packageJson, { [HOST_PACKAGE]: hostVersion }, 'dependencies', changes);
-  if (transitions) applyPackageTransitions(packageJson, transitions, changes, warnings);
+  if (transitions) {
+    applyPackageTransitions(packageJson, transitions, changes, warnings);
+    applyJsonTransitions(packageJson, transitions.fields, [], changes, warnings);
+    applyJsonTransitions(packageJson, transitions.scripts, ['scripts'], changes, warnings);
+  }
   ensureManagedValues(packageJson, profile.managedDependencies, 'dependencies', changes, warnings);
   ensureManagedValues(packageJson, profile.managedDevDependencies, 'devDependencies', changes, warnings);
   ensureManagedValues(packageJson, profile.managedOverrides, 'overrides', changes, warnings);
+  ensureManagedValues(packageJson, profile.managedScripts, 'scripts', changes, warnings);
+  for (const [name, value] of Object.entries(profile.managedFields || {})) {
+    if (packageJson[name] === undefined) {
+      changes.push(`add missing ${name}: ${formatValue(value)}`);
+      packageJson[name] = value;
+    } else if (!sameValue(packageJson[name], value)) warnings.push(`retain customized ${name}`);
+  }
   return {
     changed: changes.length > 0,
     changes,
@@ -169,18 +194,18 @@ function applyJsonTransitions(target, transitions, sectionPath, changes, warning
     section[segment] ||= {};
     section = section[segment];
   }
-  const prefix = sectionPath.join('.');
+  const prefix = sectionPath.length ? `${sectionPath.join('.')}.` : '';
   for (const [name, transition] of Object.entries(transitions || {})) {
     const current = section[name];
     if (transition.to === null) {
       if (sameValue(current, transition.from)) {
-        changes.push(`remove ${prefix}.${name}`);
+        changes.push(`remove ${prefix}${name}`);
         delete section[name];
-      } else if (current !== undefined) warnings.push(`retain customized ${prefix}.${name}`);
+      } else if (current !== undefined) warnings.push(`retain customized ${prefix}${name}`);
     } else if (current === undefined || sameValue(current, transition.from)) {
-      changes.push(`${prefix}.${name}: ${formatValue(current ?? '(missing)')} -> ${formatValue(transition.to)}`);
+      changes.push(`${prefix}${name}: ${formatValue(current ?? '(missing)')} -> ${formatValue(transition.to)}`);
       section[name] = transition.to;
-    } else if (!sameValue(current, transition.to)) warnings.push(`retain customized ${prefix}.${name}`);
+    } else if (!sameValue(current, transition.to)) warnings.push(`retain customized ${prefix}${name}`);
   }
 }
 
@@ -188,6 +213,8 @@ function patchTsconfigJson(source, transitions = null) {
   const tsconfig = JSON.parse(source);
   const changes = [];
   const warnings = [];
+  applyJsonTransitions(tsconfig, transitions?.fields, [], changes, warnings);
+  applyJsonTransitions(tsconfig, transitions?.compilerOptions, ['compilerOptions'], changes, warnings);
   applyJsonTransitions(tsconfig, transitions?.paths, ['compilerOptions', 'paths'], changes, warnings);
   return {
     changed: changes.length > 0,
@@ -197,6 +224,31 @@ function patchTsconfigJson(source, transitions = null) {
   };
 }
 
+function patchGitignore(source, transition) {
+  if (!transition) return { changed: false, changes: [], warnings: [], content: source };
+  const start = source.indexOf(GITIGNORE_START);
+  const end = source.indexOf(GITIGNORE_END);
+  const duplicateStart = start !== -1 && source.indexOf(GITIGNORE_START, start + GITIGNORE_START.length) !== -1;
+  const duplicateEnd = end !== -1 && source.indexOf(GITIGNORE_END, end + GITIGNORE_END.length) !== -1;
+  const block = `${GITIGNORE_START}\n${transition.to.trimEnd()}\n${GITIGNORE_END}`;
+  if (start === -1 && end === -1) {
+    const separator = source.length && !source.endsWith('\n\n') ? (source.endsWith('\n') ? '\n' : '\n\n') : '';
+    return { changed: true, changes: ['add Power Apps managed .gitignore block'], warnings: [], content: `${source}${separator}${block}\n` };
+  }
+  if (start === -1 || end < start || duplicateStart || duplicateEnd) {
+    throw new Error(`${GITIGNORE_PATH} has invalid Power Apps managed markers`);
+  }
+  const blockEnd = end + GITIGNORE_END.length;
+  const current = source.slice(start + GITIGNORE_START.length, end).replace(/^\r?\n|\r?\n$/g, '');
+  if (current === transition.to.trimEnd()) return { changed: false, changes: [], warnings: [], content: source };
+  return {
+    changed: true,
+    changes: ['update Power Apps managed .gitignore block'],
+    warnings: current === transition.from?.trimEnd() ? [] : ['replace customized Power Apps managed .gitignore block'],
+    content: `${source.slice(0, start)}${block}${source.slice(blockEnd)}`,
+  };
+}
+
 function buildMigrationOperations(projectRoot, migration) {
   if (!migration) return { operations: [], conflicts: [] };
   const operations = [];
@@ -278,17 +330,18 @@ function addConflict(operations, conflicts, filePath, relativePath, migrationId,
   });
 }
 
-function readProjectState(projectRoot, targetVersion, fromVersion) {
+function readProjectState(projectRoot) {
   const statePath = path.join(projectRoot, TEMPLATE_VERSION_PATH);
   if (fs.existsSync(statePath)) {
-    const state = readJson(statePath);
-    if (state.schemaVersion !== 1) throw new Error(`${TEMPLATE_VERSION_PATH} uses unsupported schemaVersion ${state.schemaVersion}`);
-    if (!Number.isInteger(state.templateVersion)) throw new Error(`${TEMPLATE_VERSION_PATH} has an invalid templateVersion`);
-    return state;
+    const state = readJson(statePath).expo?.extra?.powerappsNative;
+    if (state) {
+      if (state.schemaVersion !== 1) throw new Error(`${TEMPLATE_VERSION_PATH} uses unsupported schemaVersion ${state.schemaVersion}`);
+      if (!Number.isInteger(state.templateVersion)) throw new Error(`${TEMPLATE_VERSION_PATH} has an invalid templateVersion`);
+      validateNativeRuntimeVersions(state.nativeRuntimeVersions, `${TEMPLATE_VERSION_PATH} state`);
+      return state;
+    }
   }
-  if (fromVersion) return { schemaVersion: 1, templateVersion: fromVersion };
-  if (targetVersion === 1) return { schemaVersion: 1, templateVersion: 1 };
-  throw new Error(`Template state is missing. Rerun with --from-version <version> after identifying the app's source template version.`);
+  throw new Error(`Template state is missing from ${TEMPLATE_VERSION_PATH}.`);
 }
 
 function selectNextMigration(migrations, fromVersion, targetVersion) {
@@ -306,6 +359,7 @@ function selectNextMigration(migrations, fromVersion, targetVersion) {
 function loadMigrations(profile, migrationsDirectory) {
   if (profile.schemaVersion !== 1) throw new Error(`Compatibility profile uses unsupported schemaVersion ${profile.schemaVersion}`);
   if (!Number.isInteger(profile.targetTemplateVersion) || profile.targetTemplateVersion < 1) throw new Error('Compatibility profile has an invalid targetTemplateVersion');
+  validateNativeRuntime(profile.nativeRuntime, 'Compatibility profile');
   const ids = profile.migrations || [];
   if (new Set(ids).size !== ids.length) throw new Error('Compatibility profile contains duplicate migration IDs');
   const migrations = ids.map(migrationId => loadMigration(migrationId, migrationsDirectory));
@@ -330,10 +384,45 @@ function loadMigration(migrationId, migrationsDirectory) {
   if (!migration.targetProfile?.hostVersion || !migration.targetProfile?.expoVersion || !migration.targetProfile?.expoDoctorVersion) {
     throw new Error(`Migration ${migration.id} has an incomplete target profile`);
   }
+  for (const platform of ['android', 'ios']) {
+    const from = migration.nativeRuntimeTransition?.from?.[platform];
+    const to = migration.nativeRuntimeTransition?.to?.[platform];
+    if (!Number.isInteger(from?.version) || !Number.isInteger(to?.version) || to.version < from.version || to.version > from.version + 1) {
+      throw new Error(`Migration ${migration.id} has invalid ${platform} native runtime versions`);
+    }
+    if (!isHash(from.fingerprint) || !isHash(to.fingerprint)) {
+      throw new Error(`Migration ${migration.id} has invalid ${platform} native runtime fingerprints`);
+    }
+  }
+  validateNativeRuntime(migration.targetProfile.nativeRuntime, `Migration ${migration.id} target profile`);
+  if (JSON.stringify(migration.targetProfile.nativeRuntime) !== JSON.stringify(migration.nativeRuntimeTransition.to)) {
+    throw new Error(`Migration ${migration.id} target profile native runtime does not match its transition`);
+  }
   validatePatchMetadata(migration, patch);
   return { ...migration, patch };
 }
 
+function isHash(value) {
+  return typeof value === 'string' && /^[a-f0-9]{64}$/.test(value);
+}
+
+function validateNativeRuntime(nativeRuntime, label) {
+  for (const platform of ['android', 'ios']) {
+    const runtime = nativeRuntime?.[platform];
+    if (!Number.isInteger(runtime?.version) || runtime.version < 1 || !isHash(runtime.fingerprint)) {
+      throw new Error(`${label} has invalid ${platform} native runtime metadata`);
+    }
+  }
+}
+
+function validateNativeRuntimeVersions(versions, label) {
+  for (const platform of ['android', 'ios']) {
+    if (!Number.isInteger(versions?.[platform]) || versions[platform] < 1) {
+      throw new Error(`${label} has invalid ${platform} native runtime version`);
+    }
+  }
+}
+
 function validatePatchMetadata(migration, patch) {
   try {
     const parsedPatches = parseMigrationPatch(patch);
@@ -383,18 +472,21 @@ function validateGraph(migrations, targetVersion) {
   }
   if (migrations.length) {
     const firstVersion = Math.min(...fromVersions);
+    if (firstVersion !== 1) throw new Error('Migration graph must start at template version 1');
     for (let version = firstVersion; version < targetVersion; version += 1) {
       if (!fromVersions.has(version)) throw new Error(`Migration graph is missing template version ${version} -> ${version + 1}`);
     }
     if (Math.max(...migrations.map(migration => migration.toTemplateVersion)) !== targetVersion) {
       throw new Error(`Migration graph does not reach target template version ${targetVersion}`);
     }
+  } else if (targetVersion > 1) {
+    throw new Error(`Migration graph does not reach target template version ${targetVersion}`);
   }
 }
 
-function buildUpgradePlan(projectRoot, profile, hostVersion, fromVersion, migrationsDirectory, includeState = true) {
+function buildUpgradePlan(projectRoot, profile, hostVersion, migrationsDirectory, includeState = true) {
   const migrations = loadMigrations(profile, migrationsDirectory);
-  const state = readProjectState(projectRoot, profile.targetTemplateVersion, fromVersion);
+  const state = readProjectState(projectRoot);
   const migration = selectNextMigration(migrations, state.templateVersion, profile.targetTemplateVersion);
   const targetProfile = migration ? migration.targetProfile : profile;
   const targetHostVersion = migration ? migration.targetProfile.hostVersion : hostVersion;
@@ -410,7 +502,18 @@ function buildUpgradePlan(projectRoot, profile, hostVersion, fromVersion, migrat
     const tsconfigPatch = patchTsconfigJson(source, migration.tsconfigTransitions);
     if (tsconfigPatch.changed) operations.push({ filePath: tsconfigPath, ...tsconfigPatch });
   }
-  if (includeState) addStateOperation(operations, projectRoot, migration?.toTemplateVersion || profile.targetTemplateVersion);
+  if (migration?.gitignoreTransition) {
+    const gitignorePath = path.join(projectRoot, GITIGNORE_PATH);
+    const source = fs.existsSync(gitignorePath) ? fs.readFileSync(gitignorePath, 'utf8') : '';
+    const gitignorePatch = patchGitignore(source, migration.gitignoreTransition);
+    if (gitignorePatch.changed) operations.push({ filePath: gitignorePath, ...gitignorePatch });
+  }
+  if (includeState) addStateOperation(
+    operations,
+    projectRoot,
+    migration?.toTemplateVersion || profile.targetTemplateVersion,
+    targetProfile.nativeRuntime,
+  );
   return {
     operations,
     conflicts: [],
@@ -422,16 +525,26 @@ function buildUpgradePlan(projectRoot, profile, hostVersion, fromVersion, migrat
   };
 }
 
-function addStateOperation(operations, projectRoot, targetVersion) {
+function addStateOperation(operations, projectRoot, targetVersion, nativeRuntime) {
   const statePath = path.join(projectRoot, TEMPLATE_VERSION_PATH);
-  const nextState = { schemaVersion: 1, templateVersion: targetVersion };
-  const currentState = fs.existsSync(statePath) ? readJson(statePath) : null;
+  const nextState = {
+    schemaVersion: 1,
+    templateVersion: targetVersion,
+    nativeRuntimeVersions: Object.fromEntries(
+      ['android', 'ios'].map(platform => [platform, nativeRuntime[platform].version]),
+    ),
+  };
+  const appConfig = fs.existsSync(statePath) ? readJson(statePath) : {};
+  const currentState = appConfig.expo?.extra?.powerappsNative || null;
   if (JSON.stringify(currentState) !== JSON.stringify(nextState)) {
+    appConfig.expo ||= {};
+    appConfig.expo.extra ||= {};
+    appConfig.expo.extra.powerappsNative = nextState;
     operations.push({
       filePath: statePath,
       changed: true,
-      changes: [`record template version ${targetVersion}`],
-      content: `${JSON.stringify(nextState, null, 2)}\n`,
+      changes: [`record template version ${targetVersion} and native runtime compatibility`],
+      content: `${JSON.stringify(appConfig, null, 2)}\n`,
       state: true,
     });
   }
@@ -448,8 +561,10 @@ module.exports = {
   isCustomerOwnedPath,
   isTemplateManagedPath,
   isUnifiedPatchManagedPath,
+  loadMigrations,
   parseFileMode,
   patchTsconfigJson,
+  patchGitignore,
   patchPackageJson,
   readJson,
   readProjectState,