apache-airflow-providers-edge3 1.1.3__py3-none-any.whl → 1.2.0rc1__py3-none-any.whl

airflow/providers/edge3/plugins/edge_executor_plugin.py

@@ -23,7 +23,7 @@ from typing import TYPE_CHECKING, Any
 from airflow.configuration import conf
 from airflow.exceptions import AirflowConfigException
 from airflow.plugins_manager import AirflowPlugin
-from airflow.providers.edge3.version_compat import AIRFLOW_V_3_0_PLUS
+from airflow.providers.edge3.version_compat import AIRFLOW_V_3_0_PLUS, AIRFLOW_V_3_1_PLUS
 from airflow.utils.session import NEW_SESSION, provide_session
 
 if TYPE_CHECKING:
@@ -49,8 +49,8 @@ if AIRFLOW_V_3_0_PLUS:
 
         return {
             "app": create_edge_worker_api_app(),
-            "url_prefix": "/edge_worker/v1",
-            "name": "Airflow Edge Worker API",
+            "url_prefix": "/edge_worker",
+            "name": "Airflow Edge Worker",
         }
 
 else:
@@ -232,9 +232,49 @@ class EdgeExecutorPlugin(AirflowPlugin):
 
     name = "edge_executor"
     if EDGE_EXECUTOR_ACTIVE and RUNNING_ON_APISERVER:
+        if AIRFLOW_V_3_1_PLUS:
+            fastapi_apps = [_get_api_endpoint()]
+            react_apps = [
+                {
+                    "name": "Edge Worker",
+                    "bundle_url": "/edge_worker/static/main.umd.cjs",
+                    "destination": "nav",
+                    "url_route": "edge_worker",
+                    "category": "admin",
+                    "icon": "/edge_worker/res/cloud-computer.svg",
+                    "icon_dark_mode": "/edge_worker/res/cloud-computer-dark.svg",
+                },
+                {
+                    "name": "Edge Worker Jobs",
+                    "bundle_url": "/edge_worker/static/main.umd.cjs",
+                    "url_route": "edge_jobs",
+                    "category": "admin",
+                    "icon": "/edge_worker/res/cloud-computer.svg",
+                    "icon_dark_mode": "/edge_worker/res/cloud-computer-dark.svg",
+                },
+            ]
+            external_views = [
+                {
+                    "name": "Edge Worker API docs",
+                    "href": "/edge_worker/docs",
+                    "destination": "nav",
+                    "category": "docs",
+                    "icon": "/edge_worker/res/cloud-computer.svg",
+                    "icon_dark_mode": "/edge_worker/res/cloud-computer-dark.svg",
+                    "url_route": "edge_worker_api_docs",
+                }
+            ]
         if AIRFLOW_V_3_0_PLUS:
+            # Airflow 3.0 does not know about react_apps, so we only provide the API endpoint
             fastapi_apps = [_get_api_endpoint()]
         else:
+            appbuilder_menu_items = [
+                {
+                    "name": "Edge Worker API docs",
+                    "href": "/edge_worker/v1/ui",
+                    "category": "Docs",
+                }
+            ]
             appbuilder_views = [
                 {
                     "name": "Edge Worker Jobs",

airflow/providers/edge3/plugins/www/.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.pnpm-store
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Coverage
+coverage

airflow/providers/edge3/plugins/www/.prettierignore

@@ -0,0 +1,6 @@
+dist/
+*.md
+*.yaml
+coverage/*
+node_modules/
+openapi-gen/

airflow/providers/edge3/plugins/www/.prettierrc

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json.schemastore.org/prettierrc",
+  "endOfLine": "lf",
+  "importOrder": ["<THIRD_PARTY_MODULES>", "^src/", "^[./]"],
+  "importOrderSeparation": true,
+  "jsxSingleQuote": false,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "printWidth": 110,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}

airflow/providers/edge3/plugins/www/README.md

@@ -0,0 +1,141 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ -->
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Edge](#edge-provider-ui-plugin)
+  - [Development](#development)
+  - [Best Practices](#best-practices)
+  - [Troubleshooting](#troubleshooting)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Edge Provider UI plugin
+
+This is a React plugin template for Apache Airflow that builds as a library component for UI to provide details of Edge workers.
+
+## Development
+
+This template is configured to build your React component as a library that can be consumed by other applications.
+
+### Available Scripts
+
+- `pnpm dev` - Start development server with hot reload
+- `pnpm build` - Build the library for production
+- `pnpm build:types` - Generate TypeScript declaration files only
+- `pnpm build:lib` - Build the JavaScript library only
+- `pnpm test` - Run tests
+- `pnpm lint` - Check code quality
+- `pnpm format` - Format code
+
+### Library Output
+
+When you run `pnpm build`, the template generates:
+
+- `dist/main.js` - ES module JavaScript library
+- `dist/main.d.ts` - TypeScript declaration file
+- Source maps for debugging
+
+### Usage as a Library
+
+After building, other applications can import your component:
+
+```typescript
+import { PluginComponent } from 'your-plugin-name';
+
+// Use in your React app
+<PluginComponent />
+```
+
+### Development Mode
+
+For development and testing, use `pnpm dev` which will:
+
+- Start a development server on port 5173
+- Load the component using `src/dev.tsx` entry point
+- Enable hot module replacement
+
+To have a usable UI, please start Airflow also in parallel via
+`breeze start-airflow`.
+
+### Library Configuration
+
+The template is configured with:
+
+- **Vite** for fast building and development
+- **TypeScript** with declaration file generation
+- **CSS injection** - styles are automatically injected into the JavaScript bundle
+- **External dependencies** - React and other common libraries are marked as external to reduce bundle size
+
+### Customization
+
+1. **Component Props**: Update the `PluginComponentProps` interface in `src/main.tsx`
+2. **External Dependencies**: Modify the `external` array in `vite.config.ts`
+3. **Build Output**: Adjust library configuration in `vite.config.ts`
+
+### Package Configuration
+
+The `package.json` is configured with:
+
+- `main` and `module` pointing to the built library
+- `types` pointing to generated declaration files
+- `exports` for modern import/export support
+- `files` array specifying what gets published
+
+This ensures your plugin can be consumed as both a CommonJS and ES module with full TypeScript support.
+
+## Best Practices
+
+1. **Keep React External**: Always mark React ecosystem as external to avoid conflicts
+2. **Global Naming**: Use standardized global name (`AirflowPlugin`) for consistency
+3. **Error Handling**: Implement proper error boundaries and fallbacks
+4. **TypeScript**: Use proper typing for plugin props and exports
+5. **Bundle Size**: Monitor bundle size and externalize large dependencies if needed
+
+## Troubleshooting
+
+### Common Issues
+
+**"Failed to resolve module specifier 'react'"**
+
+- Ensure React is marked as external in `vite.config.ts`
+- Verify host application exposes React globally
+
+**"Cannot read properties of null (reading 'useState')"**
+
+- React instance mismatch - check external configuration
+- Verify global React is properly set in host application
+
+**"Objects are not valid as a React child"**
+
+- Ensure you're returning component functions, not JSX elements
+- Check that lazy loading returns proper component structure
+
+**MIME type issues**
+
+- Ensure `.js` and `.cjs` files are served with correct MIME type
+
+For more help, check the main project documentation.
+
+### Deployment to Airflow Plugins
+
+Once the development is complete, you can build the library using `pnpm build` and then host the content of the `dist` folder. You can do that on your own infrastructure or within airflow
+by adding static file serving to your api server via registering a plugin `fastapi_apps`. You can take a look at the [Airflow documentation](https://airflow.apache.org/docs/apache-airflow/stable/plugins.html) for more information on how to do that.

airflow/providers/edge3/plugins/www/dist/main.d.ts

@@ -0,0 +1 @@
+export {}