improve error message for installation fail, bump ghaction versions

Author: MFA-X-AI

.github/workflows/build-python-wheel.yml

@@ -5,12 +5,6 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
-  workflow_dispatch:
-    inputs:
-      branch:
-        description: 'Branch to run the workflow on'
-        required: false
-        default: 'master'
 
 jobs:
   build:
@@ -21,31 +15,33 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v3
-      with:
-        ref: ${{ github.event.inputs.branch || github.ref }}
-
+    - uses: actions/checkout@v4
+    
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Set Branch Name
+    - name: Determine Branch Name
       run: |
-        if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
-          echo "branch_name=${{ github.event.inputs.branch }}" >> $GITHUB_ENV
+        if [ "${{ github.event_name }}" == "pull_request" ]; then
+          branch_name="${{ github.head_ref }}"
         else
-          echo "branch_name=${{ github.ref_name }}" >> $GITHUB_ENV
+          branch_name="${{ github.ref_name }}"
         fi
+        echo "branch_name=$branch_name" >> $GITHUB_ENV
 
-    - name: Check Branch
-      run: echo "Branch name is ${{ env.branch_name }}"
-
-    - name: Get Hash
-      run: echo "git_hash=$(git rev-parse --short ${{ github.sha }})" >> $GITHUB_ENV
+    - name: Sanitize Branch Name and Git Hash
+      run: |
+        sanitized_branch_name=$(echo "$branch_name" | sed 's/[^a-zA-Z0-9_-]/_/g')  # Preserving hyphens
+        sanitized_git_hash=$(git rev-parse --short "$GITHUB_SHA" | sed 's/[^a-zA-Z0-9_-]/_/g')  # Preserving hyphens
+        echo "sanitized_branch_name=$sanitized_branch_name" >> $GITHUB_ENV
+        echo "sanitized_git_hash=$sanitized_git_hash" >> $GITHUB_ENV
 
-    - name: Check Hash
-      run: echo "Git hash is ${{ env.git_hash }}"
+    - name: Check Branch and Hash
+      run: |
+        echo "Branch: $sanitized_branch_name"
+        echo "Hash: $sanitized_git_hash"
 
     - name: Setup Node.js
       uses: actions/setup-node@v4
@@ -60,21 +56,14 @@ jobs:
 
     - name: Build Extension in Dev Mode
       run: pip install -e .
-
+                
     - name: Build Wheel
       run: |
         python -m pip install --upgrade build
         python -m build
 
-    - name: Sanitize Branch Name and Git Hash
-      run: |
-        sanitized_branch_name=$(echo "${{ env.branch_name }}" | sed 's/[^a-zA-Z0-9_]/_/g')
-        sanitized_git_hash=$(echo "${{ env.git_hash }}" | sed 's/[^a-zA-Z0-9_]/_/g')
-        echo "sanitized_branch_name=$sanitized_branch_name" >> $GITHUB_ENV
-        echo "sanitized_git_hash=$sanitized_git_hash" >> $GITHUB_ENV
-
-    - uses: actions/upload-artifact@v3
+    - name: Upload Dist Directory Artifact
+      uses: actions/upload-artifact@v4
       with:
-        name: xircuits-wheel-${{ env.sanitized_branch_name }}-${{ env.sanitized_git_hash }}
+        name: xircuits-wheel-${{ env.sanitized_branch_name }}-${{ matrix.python-version }}-${{ env.sanitized_git_hash }}
         path: dist
-        if-no-files-found: warn

.github/workflows/pypi-github-release-publish.yml

@@ -8,9 +8,9 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9'
     - name: Install dependencies
@@ -19,7 +19,7 @@ jobs:
         pip install setuptools wheel
 
     - name: Setup Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 18
 
@@ -36,7 +36,7 @@ jobs:
         python -m build
 
     - name: Upload Artifacts
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: xircuits-wheel
         path: dist

.github/workflows/run-ui-tests.yml

@@ -21,12 +21,12 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: ${{ github.event.inputs.branch || github.ref }}
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -48,7 +48,7 @@ jobs:
       run: echo "Git hash is ${{ env.git_hash }}"
 
     - name: Setup Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 18
 
@@ -81,7 +81,7 @@ jobs:
       run: |
         (jupyter lab --ServerApp.token='' --ServerApp.password='' --LabApp.default_url='/lab?reset' &) && cd ui-tests && jlpm install && jlpm playwright install && xvfb-run jlpm playwright test e2e/datatype-test.spec.ts
 
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       if: failure()
       with:
         name: playwright-report-${{ matrix.python-version }}-${{ env.branch_name }}-${{ env.git_hash }}

xircuits/handlers/request_submodule.py

@@ -16,9 +16,8 @@ def get_submodule_config(user_query):
 
     submodule_keys = [submodule for submodule in config.sections() if user_query in submodule]
     if len(submodule_keys) == 0:
-        print(user_query + " component library submodule not found.")
-        return
-        
+        raise ValueError(f"{user_query} component library submodule not found.")
+    
     if len(submodule_keys) > 1:
         raise ValueError(f"Multiple instances of '{user_query}' found.")
 
@@ -30,13 +29,15 @@ def get_submodule_config(user_query):
     return submodule_path, submodule_url
 
 
-def request_submodule_library(component_library_query):
-    
-    submodule_path, submodule_url = get_submodule_config(component_library_query)
-    
-    print("Cloning " + submodule_path + " from " + submodule_url)
-    Repo.clone_from(submodule_url, submodule_path, progress=Progress())
 
+def request_submodule_library(component_library_query) -> (bool, str):
+    try:
+        submodule_path, submodule_url = get_submodule_config(component_library_query)
+        print("Cloning " + submodule_path + " from " + submodule_url)
+        Repo.clone_from(submodule_url, submodule_path, progress=Progress())
+        return True, f"Successfully cloned {submodule_path}."
+    except ValueError as e:
+        return False, str(e)
 
 def get_submodules(repo, ref="master"):
     try:

xircuits/library/install_fetch_library.py

@@ -31,13 +31,15 @@ def get_component_library_path(library_name: str) -> str:
     else:
         return build_component_library_path(library_name)
 
-def install_library(library_name: str) -> str:
-    messages = []
+def install_library(library_name: str):
     print(f"Installing {library_name}...")
     component_library_path = get_component_library_path(library_name)
 
     if not Path(component_library_path).is_dir() or is_empty(component_library_path):
-        request_submodule_library(component_library_path)
+        success, message = request_submodule_library(component_library_path)
+        if not success:
+            print(message)
+            return
 
     # Get config and determine requirements path
     config = get_library_config(library_name)
@@ -49,21 +51,22 @@ def install_library(library_name: str) -> str:
             print(f"Installing requirements for {library_name}...")
             subprocess.run([sys.executable, "-m", "pip", "install", "-r", str(requirements_path)], check=True)
         except Exception as e:
-            raise RuntimeError(f"An error occurred while installing requirements for {library_name}: {e}")
+            print(f"An error occurred while installing requirements for {library_name}: {e}")
+
     else:
-        messages.append(f"No requirements.txt found for {library_name}. Skipping installation of dependencies.")
+        print(f"No requirements.txt found for {library_name}. Skipping installation of dependencies.")
 
-    messages.append(f"Library {library_name} ready to use.")
-    return '\n'.join(messages)
+    print(f"Library {library_name} ready to use.")
 
-def fetch_library(library_name: str) -> str:
-    messages = [f"Fetching {library_name}..."]
+def fetch_library(library_name: str):
+    print(f"Fetching {library_name}...")
     component_library_path = get_component_library_path(library_name)
 
     if not Path(component_library_path).is_dir() or is_empty(component_library_path):
-        request_submodule_library(component_library_path)
-        messages.append(f"{library_name} library fetched and stored in {component_library_path}.")
+        success, message = request_submodule_library(component_library_path)
+        if success:
+            print(f"{library_name} library fetched and stored in {component_library_path}.")
+        else:
+            print(message)
     else:
-        messages.append(f"{library_name} library already exists in {component_library_path}.")
-
-    return '\n'.join(messages)
+        print(f"{library_name} library already exists in {component_library_path}.")