Merge pull request #270 from ZephyrCloudIO/feat/metro-plugin-v2

feat(zephyr-metro-plugin): add Metro bundler plugin for React Native

Author: HigorAlves

libs/with-zephyr/project.json

@@ -9,6 +9,7 @@
     "build": {
       "executor": "nx:run-commands",
       "outputs": ["{projectRoot}/dist"],
+      "dependsOn": ["^build"],
       "options": {
         "command": "pnpm build",
         "cwd": "libs/with-zephyr"

libs/zephyr-agent/src/lib/deployment/aws-upload.strategy.ts

@@ -5,7 +5,7 @@ import { ZeErrors, ZephyrError } from '../errors';
 import { getApplicationConfiguration } from '../edge-requests/get-application-configuration';
 import { makeRequest } from '../http/http-request';
 import { zeUploadSnapshot } from '../edge-actions';
-import {type UploadAssetsOptions, uploadBuildStatsAndEnableEnvs } from './upload-base';
+import { type UploadAssetsOptions, uploadBuildStatsAndEnableEnvs } from './upload-base';
 import { update_hash_list } from '../edge-hash-list/distributed-hash-control';
 import { white, whiteBright } from '../logging/picocolor';
 import type { UploadFileProps } from '../http/upload-file';
@@ -15,7 +15,7 @@ const AWS_MAX_BODY_SIZE = 20971520;
 
 export async function awsUploadStrategy(
   zephyr_engine: ZephyrEngine,
-  { snapshot, getDashData, assets: { assetsMap, missingAssets } }: UploadOptions,
+  { snapshot, getDashData, assets: { assetsMap, missingAssets } }: UploadOptions
 ): Promise<string> {
   const snapshotSize = Buffer.byteLength(JSON.stringify(snapshot), 'utf8');
   if (snapshotSize > AWS_MAX_BODY_SIZE) {
@@ -145,12 +145,13 @@ async function zeUploadAssets(
       return;
     }
 
-    const [ok, cause] = await makeRequest(result.url,
+    const [ok, cause] = await makeRequest(
+      result.url,
       {
         method: 'PUT',
         headers: {
           'Content-Type': result.contentType,
-        }
+        },
       },
       asset.buffer
     );
@@ -174,7 +175,7 @@ async function zeUploadAssets(
   async function getUploadUrl(
     { hash, asset }: UploadFileProps,
     { EDGE_URL, jwt }: ZeApplicationConfig
-  ): Promise<{url: string; contentType: string; message?: string;}> {
+  ): Promise<{ url: string; contentType: string; message?: string }> {
     const type = 'uploadUrl';
     const options: RequestInit = {
       method: 'POST',
@@ -186,7 +187,7 @@ async function zeUploadAssets(
       },
     };
 
-    const [ok, cause, data] = await makeRequest<{url: string; contentType: string;}>(
+    const [ok, cause, data] = await makeRequest<{ url: string; contentType: string }>(
       {
         path: '/upload',
         base: EDGE_URL,

libs/zephyr-agent/src/lib/node-persist/storage-keys.ts

@@ -3,15 +3,17 @@ import * as os from 'node:os';
 import * as path from 'node:path';
 
 export const ZE_PATH = path.resolve(os.homedir(), '.zephyr');
+export const ZE_PERSIST_PATH = path.resolve(ZE_PATH, 'persist');
 export const ZE_SESSION_LOCK = path.resolve(ZE_PATH, 'session');
 
 try {
-  // Ensures that the directory exists and lockfile is writable
+  // Ensures that the directories exist and lockfile is writable
   fs.mkdirSync(ZE_PATH, { recursive: true });
+  fs.mkdirSync(ZE_PERSIST_PATH, { recursive: true });
 } catch (error) {
   console.error(
     'error',
-    `Could not create ~/.zephyr directory. Please check your permissions: ${error}`
+    `Could not create ~/.zephyr directories. Please check your permissions: ${error}`
   );
 }
 

libs/zephyr-agent/src/lib/node-persist/storage.ts

@@ -1,10 +1,7 @@
 import { init } from 'node-persist';
-import { ZE_PATH } from './storage-keys';
+import { ZE_PERSIST_PATH } from './storage-keys';
 
 /** @internal */
 export const storage = init({
-  dir: ZE_PATH,
-  // node-persist thinks every file in .zephyr folder is a JSON valid file,
-  // since we use that folder for other purposes too, we need to set this to true
-  forgiveParseErrors: true,
+  dir: ZE_PERSIST_PATH,
 });

libs/zephyr-agent/src/tests/ze-agent.spec.ts

@@ -59,7 +59,7 @@ runner('ZeAgent', () => {
     if (fs.existsSync(zephyrAppFolder)) {
       const files = fs.readdirSync(zephyrAppFolder);
       files.forEach((file) => {
-        fs.rmSync(path.join(zephyrAppFolder, file));
+        fs.rmSync(path.join(zephyrAppFolder, file), { recursive: true });
       });
     }
     await exec(`git config --add user.name "${gitUserName}"`);

libs/zephyr-agent/src/zephyr-engine/index.ts

@@ -80,6 +80,7 @@ type ZephyrEngineBuilderTypes =
   | 'webpack'
   | 'rspack'
   | 'repack'
+  | 'metro'
   | 'vite'
   | 'rollup'
   | 'parcel'

libs/zephyr-edge-contract/package.json

@@ -13,6 +13,14 @@
     "url": "https://github.com/ZephyrCloudIO"
   },
   "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

libs/zephyr-edge-contract/src/index.ts

@@ -21,7 +21,11 @@ export type { ZeApplicationList } from './lib/ze-api/app-list';
 export type { ZeAppVersion, ZeAppVersionResponse } from './lib/ze-api/app-version';
 export type { ConvertedGraph } from './lib/ze-api/converted-graph';
 export type { LocalPackageJson } from './lib/ze-api/local-package-json';
-export type { ZephyrBuildStats, ZephyrDependency } from './lib/zephyr-build-stats';
+export type {
+  ApplicationConsumes,
+  ZephyrBuildStats,
+  ZephyrDependency,
+} from './lib/zephyr-build-stats';
 export type {
   Asset,
   SnapshotUploadRes,

libs/zephyr-metro-plugin/.eslintrc.json

@@ -0,0 +1,35 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["libs/zephyr-metro-plugin/tsconfig.spec.json"]
+      },
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {
+        "@nx/enforce-module-boundaries": [
+          "error",
+          {
+            "enforceBuildableLibDependency": false,
+            "allow": ["^zephyr-agent$"],
+            "depConstraints": [
+              {
+                "sourceTag": "*",
+                "onlyDependOnLibsWithTags": ["*"]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/zephyr-metro-plugin/.npmignore

@@ -0,0 +1,5 @@
+src
+tsconfig.*
+jest.config.ts
+project.json
+.eslintrc.json