feat(upgrade): added restoring backup files

Author: Murat

src/__tests__/unit/upgrade.spec.ts

@@ -10,6 +10,10 @@ const mockParseConfig = jest.spyOn(
   require('../../utils/parseConfig'),
   'parseConfig'
 );
+const mockRestoreBackupFiles = jest.spyOn(
+  require('../../utils/upgrade/restoreBackupFiles'),
+  'restoreBackupFiles'
+);
 
 import { Constants } from '../../constants';
 import { upgrade } from '../../upgrade';
@@ -26,6 +30,26 @@ describe('upgrade', () => {
       expect.stringContaining('skipping import from old project')
     );
   });
+  it('should restore files', async () => {
+    mockPrompter.text.mockImplementationOnce(() => '');
+    mockRestoreBackupFiles.mockReturnValueOnce(Promise.resolve(true));
+
+    await upgrade();
+
+    expect(mockPrompter.log.message).toHaveBeenCalledWith(
+      expect.stringContaining('skipping import from old project')
+    );
+  });
+  it('should handle restore error', async () => {
+    mockPrompter.text.mockImplementationOnce(() => '');
+    mockRestoreBackupFiles.mockRejectedValueOnce(new Error('test'));
+
+    await upgrade();
+
+    expect(mockPrompter.log.message).toHaveBeenCalledWith(
+      expect.stringContaining('skipping import from old project')
+    );
+  });
   it('should not run tasks when lock does not exist', async () => {
     const spinner = mockPrompter.spinner();
     spinner.stop.mockReset();

src/__tests__/unit/utils/upgrade/restoreBackupFiles.spec.ts

@@ -0,0 +1,38 @@
+require('../../../mocks/mockAll');
+import path from 'path';
+import { getProjectPath } from '../../../../utils/getProjectPath';
+import { restoreBackupFiles } from '../../../../utils/upgrade/restoreBackupFiles';
+import { mockFs } from '../../../mocks/mockFs';
+
+describe('restoreBackupFiles', () => {
+  it('should restore backup files in .upgrade', async () => {
+    mockFs.writeFileSync(
+      path.join(getProjectPath(), '.upgrade/backup/test/some.file'),
+      'random'
+    );
+
+    const didRestore = await restoreBackupFiles();
+
+    expect(didRestore).toBeTruthy();
+    expect(
+      mockFs.readFileSync(path.join(getProjectPath(), 'test/some.file'))
+    ).toEqual('random');
+  });
+  it('should handle not finding backup files', async () => {
+    const didRestore = await restoreBackupFiles();
+
+    expect(didRestore).toBeFalsy();
+  });
+  it('should handle copy error', async () => {
+    mockFs.writeFileSync(
+      path.join(getProjectPath(), '.upgrade/backup/test/some.file'),
+      'random'
+    );
+    mockFs.copyFile.mockImplementationOnce(
+      (from: string, to: string, cb: CallableFunction) => {
+        cb(new Error('random'));
+      }
+    );
+    await expect(restoreBackupFiles()).rejects.toThrow('random');
+  });
+});

src/upgrade.ts

@@ -23,6 +23,7 @@ import { taskManager } from './utils/taskManager';
 import { topologicalSort } from './utils/topologicalSort';
 import { updateIntegrationStatus } from './utils/updateIntegrationStatus';
 import { importFromOldProject } from './utils/upgrade/importFromOldProject';
+import { restoreBackupFiles } from './utils/upgrade/restoreBackupFiles';
 import { validateOldProjectPath } from './utils/upgrade/validateOldProjectPath';
 import { getText, transformTextInObject, variables } from './variables';
 
@@ -310,4 +311,19 @@ export async function upgrade(): Promise<void> {
   }
 
   updateIntegrationStatus(packageLockUpdates);
+
+  logInfo(
+    color.bold(color.inverse(color.magenta(' stage 3 '))) +
+      color.bold(color.magenta(' Restore backup files '))
+  );
+
+  const didRestore = await restoreBackupFiles().catch((e: Error) => {
+    logWarning(e.message);
+  });
+  if (didRestore) {
+    logSuccess(
+      color.inverse(color.bold(color.green(' restored '))) +
+        color.green(' backup files were restored successfully')
+    );
+  }
 }

src/utils/upgrade/android/importAndroidLaunchIcon.ts

@@ -11,7 +11,7 @@ export function importAndroidLaunchIcon(
 ): ImportGetter | null {
   try {
     const mipmaps = globSync(
-      path.join(projectPath, 'android/app/src/main/res/mipmap-*/*'),
+      [projectPath, 'android/app/src/main/res/mipmap-*/*'].join('/'),
       { nodir: true }
     );
     // get launcher icon and launcher round icon name from AndroidManifest.xml

src/utils/upgrade/ios/importIosAssets.ts

@@ -12,11 +12,11 @@ export function importIosAssets(projectPath: string): ImportGetter | null {
     const iosProjectName = getIosProjectName(projectPath);
 
     const imagesAssets = globSync(
-      path.join(projectPath, 'ios', iosProjectName, 'Images.xcassets/**/*'),
+      [projectPath, 'ios', iosProjectName, 'Images.xcassets/**/*'].join('/'),
       { nodir: true }
     );
     const launchScreen = globSync(
-      path.join(projectPath, 'ios', iosProjectName, 'LaunchScreen.storyboard'),
+      [projectPath, 'ios', iosProjectName, 'LaunchScreen.storyboard'].join('/'),
       { nodir: true }
     );
 
@@ -36,7 +36,7 @@ export function importIosAssets(projectPath: string): ImportGetter | null {
 async function setIosAssets(assets: string[], launchScreen: string) {
   const iosProjectName = getIosProjectName();
   const existingAssets = globSync(
-    path.join(getProjectPath(), 'ios', iosProjectName, 'Images.xcassets/**/*'),
+    [getProjectPath(), 'ios', iosProjectName, 'Images.xcassets/**/*'].join('/'),
     { nodir: true }
   );
   // delete existing image assets

src/utils/upgrade/restoreBackupFiles.ts

@@ -0,0 +1,51 @@
+import fs from 'fs';
+import { globSync } from 'glob';
+import path from 'path';
+import color from 'picocolors';
+import { Constants } from '../../constants';
+import {
+  logMessageGray,
+  startSpinner,
+  stopSpinner,
+  updateSpinner,
+} from '../../prompter';
+import { getProjectPath } from '../getProjectPath';
+
+export async function restoreBackupFiles(): Promise<boolean> {
+  const backupFiles = globSync(
+    [getProjectPath(), Constants.UPGRADE_FOLDER_NAME, 'backup', '**/*'].join(
+      '/'
+    ),
+    { nodir: true }
+  );
+  if (backupFiles.length === 0) {
+    logMessageGray('skipped restore, no backup files found');
+    return false;
+  }
+
+  startSpinner(`copying files from ${color.yellow('.upgrade/backup')}`);
+
+  for (let i = 0; i < backupFiles.length; i++) {
+    updateSpinner(
+      `copying files from ${color.yellow('.upgrade/backup')} (${i + 1}/${backupFiles.length})`
+    );
+    const file = backupFiles[i];
+    const relativePath = path.relative(
+      path.join(getProjectPath(), Constants.UPGRADE_FOLDER_NAME, 'backup'),
+      file
+    );
+    const destination = path.join(getProjectPath(), relativePath);
+    // ensure dir exists
+    await new Promise(r =>
+      fs.mkdir(path.dirname(destination), { recursive: true }, r)
+    );
+    await new Promise((res, rej) => {
+      fs.copyFile(file, destination, err => {
+        if (err) rej(err);
+        else res(null);
+      });
+    });
+  }
+  stopSpinner(`copied ${color.yellow(backupFiles.length)} files`);
+  return true;
+}

website/docs/for-developers/guides/_category_.json

@@ -1,4 +1,8 @@
 {
   "label": "Guides",
-  "position": 2
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Configuration guides"
+  }
 }

website/docs/for-developers/guides/task-types/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Task Types",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "All possible task types that can be defined in configuration."
+  }
+}

website/docs/for-developers/android-tasks/_category_.json renamed to website/docs/for-developers/guides/task-types/android-tasks/_category_.json

@@ -12,9 +12,9 @@ The `android_manifest` task allows you to modify the AndroidManifest.xml file in
 | Property | Type                                            | Description                                                                                                                                                  |
 |:---------|:------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | type     | "android_manifest", required                    | Specifies the task type, which should be set to "android_manifest" for this task.                                                                            |
-| name     | string                                          | An optional name for the task. If provided, the task state will be saved as a variable. Visit [Task and Action States](../guides/states) page to learn more. |
+| name     | string                                          | An optional name for the task. If provided, the task state will be saved as a variable. Visit [Task and Action States](../../states) page to learn more. |
 | label    | string                                          | An optional label or description for the task.                                                                                                               |
-| when     | object                                          | Visit [Conditional Tasks and Actions](../guides/when) page to learn how to execute task conditionally.                                                       |
+| when     | object                                          | Visit [Conditional Tasks and Actions](../../when) page to learn how to execute task conditionally.                                                       |
 | actions  | Array\<[Action](#action-properties)\>, required | An array of action items that define the modifications to be made in the file. Each action item contains the following fields:                               |
 
 ## Action Properties
@@ -23,8 +23,8 @@ The `android_manifest` task allows you to modify the AndroidManifest.xml file in
 
 | Property   | Type                                       | Description                                                                                                                                                                                             |
 |:-----------|:-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| name       | string                                     | An optional name for the task. If provided, the task state will be saved as a variable. Visit [Task and Action States](../guides/states) page to learn more.                                            |
-| when       | object                                     | Visit [Conditional Tasks and Actions](../guides/when)  page to learn how to execute action conditionally.                                                                                               |
+| name       | string                                     | An optional name for the task. If provided, the task state will be saved as a variable. Visit [Task and Action States](../../states) page to learn more.                                            |
+| when       | object                                     | Visit [Conditional Tasks and Actions](../../when)  page to learn how to execute action conditionally.                                                                                               |
 
 ### Context reduction properties