@optimizely/ocp-local-env 1.0.0-beta.9 → 1.0.1

package/README.md

@@ -19,7 +19,7 @@ The OCP Local Testing Tool enables developers to build, test, and debug OCP appl
 
 ## Prerequisites
 
-- Node.js v14 or later
+- Node.js v18 or later
 - Yarn or npm
 - Modern web browser (Chrome, Firefox, Edge, or Safari)
 
@@ -30,158 +30,43 @@ The OCP Local Testing Tool enables developers to build, test, and debug OCP appl
 npm install -g @optimizely/ocp-local-env
 ```
 
-If you run nodeJS with `nvm`, you can just run `ocp-local-env` command in your terminal. You will need to run `npm install -g @optimizely/ocp-local-env` command for every node version you are using. 
-
-If you are not using `nvm`, you might need to add the output of `npm bin -g` command to your `PATH` environment variable, open you terminal and then run `ocp-local-env` command. 
-
 ## Quick Start
 
 1. Navigate to your OCP app directory (containing app.yml)
 2. Run the local testing tool
+
    ```bash
    ocp-local-env
    ```
-3. The tool will automatically open your browser to http://localhost:3000
-4. Start developing and testing your OCP app
-
-## Configuration
-
-The OCP Local Testing Tool can be configured through environment variables and configuration files.
-
-### Environment Variables
-
-Create a `.env.local` file in your project root to configure the tool:
-
-```bash
-# Copy the example file
-cp .env.example .env.local
-```
-
-Available configuration options:
-
-- `APP_ROOT_DIR`: Root directory for the OCP app (default: current directory)
-- `OCP_LOCAL_PORT`: Port to run the server on (default: 3000)
-- `OCP_LOCAL_VERBOSE`: Enable verbose logging (default: false)
-
-### Command Line Options
-
-The `ocp-local-env` command supports several options:
-
-```bash
-ocp-local-env [options]
-
-Options:
-  -p, --port <port>    Port to run the server on (default: 3000)
-  -c, --config <path>  Path to custom config file
-  --path <path>        Path to the OCP app root directory
-  -v, --verbose        Enable verbose logging
-  --no-open           Don't automatically open browser
-  -h, --help           Display help for command
-```
-
-You can also use the explicit `start` command:
-
-```bash
-ocp-local-env start [options]
-```
-
-### Configuration File
-
-You can create a `.ocp-local/config.json` file in your app directory to configure advanced options:
-
-```json
-{
-  "account": {
-    "organizationId": "my-org-123",
-    "instanceId": "my-instance-456",
-    "trackerId": "my-tracker-id"
-  }
-}
-```
-
-**Account Configuration Options:**
-
-- `organizationId` (optional): Organization ID for the account context (default: `"local-test-org"`)
-- `instanceId` (optional): Instance ID for the account context (default: `"local-test-instance"`)
-- `trackerId` (optional): Tracker ID for the account context (default: `"local-testing-tracker"`)
-
-These values are used to populate the `account` object in the AppContext that's available to your app code via the app SDK. This allows you to test your app with different account configurations.
-
-### Examples
-
-```bash
-# Start with a specific app directory
-ocp-local-env --path /path/to/my-ocp-app
 
-# Start on a different port
-ocp-local-env --port 8080
-
-# Enable verbose logging
-ocp-local-env --verbose
-
-# Don't open browser automatically
-ocp-local-env --no-open
-
-# Combine options
-ocp-local-env --path /path/to/my-ocp-app --port 8080 --verbose
-```
-
-## Documentation
-
-For detailed documentation, see the following guides:
-
-- [Design Document](docs/design-document.md) - Overall architecture and design
-- [Technical Specifications](docs/technical-specifications.md) - Detailed implementation specifications
-- [Usage Guide](docs/usage-guide.md) - How to use the OCP Local Testing Tool
-- [Project Structure](docs/project-structure.md) - Code organization and architecture
-- [Implementation Plan](docs/implementation-plan.md) - Phased approach to building the tool
+3. The tool will automatically open your browser to <http://localhost:3000>
+4. Start developing and testing your OCP app
 
 ## Development
 
-### Setting Up the Development Environment
+### Running Tests
 
 ```bash
-# Clone the repository
-git clone https://github.com/optimizely/ocp-local-env.git
-cd ocp-local-env
+# Run unit tests
+yarn test
 
-# Crate .env.local file and set `APP_ROOT_DIR` variable - this should be the full path to the app directory you want to test
-cp .env.example .env.local
+# Run E2E tests (requires setup first)
+yarn test:e2e:setup    # Clone test app and install dependencies
+yarn test:e2e          # Run Playwright tests
 
-# Install dependencies
-yarn install
-
-# Build the project
-yarn build
-
-# Start the development server
-yarn dev
+# E2E test options
+yarn test:e2e:ui       # Run with Playwright UI
+yarn test:e2e:debug    # Run in debug mode
 ```
 
-### Project Structure
-
-The project follows a modular structure with clear separation of concerns:
+### E2E Test App
 
-- `src/server`: Server-side code for simulating the OCP platform
-- `src/ui`: React-based user interface
-- `src/executor`: Code execution and file watching
-- `docs`: Documentation files
+E2E tests use a real OCP app (`hub-shakedown`) to test the local testing tool. The app is cloned into `e2e/apps/` during setup. You can specify a different test app using the `E2E_TEST_APP` environment variable.
 
-For more details, see the [Project Structure](docs/project-structure.md) document.
-
-## Contributing
-
-Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
-
-## License
+## Documentation
 
-This project is licensed under the [MIT License](LICENSE).
+https://docs.developers.optimizely.com/optimizely-connect-platform/docs/local-testing#/versions
 
 ## Support
 
-For support, please create an issue on the [GitHub repository](https://github.com/optimizely/ocp-local-env/issues) or contact the Optimizely Connect Platform team.
-
-## Acknowledgements
-
-- Optimizely Connect Platform Team
-- OCP App Developers Community
+For support, please create an issue on the [GitHub repository](https://github.com/optimizely/ocp-developer-feedback/issues/new/choose) or contact the Optimizely Connect Platform team.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@optimizely/ocp-local-env",
-    "version": "1.0.0-beta.9",
+    "version": "1.0.1",
     "description": "Local testing environment for Optimizely Connect Platform (OCP) applications",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
@@ -12,11 +12,15 @@
     ],
     "scripts": {
         "build": "tsc && webpack --mode production",
-        "dev": "concurrently \"tsc --watch\" \"webpack --mode development --watch\" \"nodemon dist/src/server.js\"",
+        "dev": "concurrently \"tsc --watch\" \"webpack --mode development --watch\" \"OCP_LOCAL_OPEN_BROWSER=false nodemon dist/src/server.js\"",
         "dev:server": "tsc --watch && nodemon dist/src/server.js",
         "dev:ui": "webpack --mode development --watch",
         "start": "node dist/src/server.js",
         "test": "jest",
+        "test:e2e": "playwright test",
+        "test:e2e:setup": "node scripts/setup-e2e-apps.js",
+        "test:e2e:ui": "playwright test --ui",
+        "test:e2e:debug": "playwright test --debug",
         "lint": "npx eslint 'src/**'",
         "format": "prettier --write \"src/**/*.{ts,tsx}\"",
         "prepare": "npm run build",
@@ -42,8 +46,6 @@
     "dependencies": {
         "@faker-js/faker": "^10.1.0",
         "@reduxjs/toolkit": "^2.11.0",
-        "@zaiusinc/app-sdk": "^2.3.0",
-        "@zaiusinc/node-sdk": "^2.0.0",
         "chalk": "^4.1.2",
         "chokidar": "^3.5.3",
         "commander": "^9.4.1",
@@ -56,9 +58,12 @@
         "react-dom": ">=17.0.0",
         "react-redux": "^9.2.0",
         "react-router-dom": "^6.28.0",
+        "semver": "^7.7.4",
         "uuid": "^9.0.0"
     },
     "devDependencies": {
+        "@optimizely/axiom-icons": "^1.13.1",
+        "@playwright/test": "^1.40.0",
         "@testing-library/dom": "^10.4.1",
         "@testing-library/jest-dom": "^6.9.1",
         "@testing-library/react": "^16.3.0",
@@ -69,24 +74,25 @@
         "@types/node": "^18.19.122",
         "@types/react": "^18.3.23",
         "@types/react-dom": "^18.3.7",
+        "@types/semver": "^7.7.1",
         "@types/uuid": "^9.0.0",
         "@typescript-eslint/eslint-plugin": "^5.48.0",
         "@typescript-eslint/parser": "^5.48.0",
         "concurrently": "^7.6.0",
         "css-loader": "^6.7.3",
-        "eslint": "^8.31.0",
+        "eslint": "^9.26.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-react": "^7.31.11",
         "html-webpack-plugin": "^5.5.0",
         "husky": "^8.0.3",
         "identity-obj-proxy": "^3.0.0",
         "jest": "^29.3.1",
-        "jest-environment-jsdom": "^30.2.0",
-        "lint-staged": "^16.2.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "lint-staged": "^15.2.0",
         "nodemon": "^3.1.10",
         "parse-path": "^7.0.0",
         "prettier": "^2.8.1",
-        "release-it": "^19.0.5",
+        "release-it": "^17.10.0",
         "style-loader": "^3.3.1",
         "ts-jest": "^29.0.3",
         "ts-loader": "^9.4.2",
@@ -99,7 +105,7 @@
         "react-dom": ">=17.0.0"
     },
     "engines": {
-        "node": ">=14.0.0"
+        "node": ">=18.0.0"
     },
     "lint-staged": {
         "*.{ts,tsx}": [