Merge branch 'main' of https://github.com/e-mission/nrel-openpath-deploy-configs

Author: shankari

.github/actions/convertIssue/issue-to-json.js

@@ -42,8 +42,13 @@ export async function issueToJson() {
 
     let abbrevKey = getInput("hash-property-name");
     abbrevKey = abbrevKey.toLowerCase();
-    let fileName = getFileName(configData[ abbrevKey ]);
-    await writeFile(path.join(outputDir, fileName), JSON.stringify(configData, null, 2));
+    let abbrev = configData[abbrevKey];
+    exportVariable("UrlAbbreviation", abbrev);
+    let fileName = getFileName(abbrev);
+    await writeFile(
+      path.join(outputDir, fileName),
+      JSON.stringify(configData, null, 4) + "\n",
+    );
   } catch (error) {
     setFailed(error.message);
   }

.github/workflows/config-update.yml

@@ -0,0 +1,73 @@
+name: Update Deployment Config
+
+on:
+  workflow_dispatch:
+    inputs:
+      deployment:
+        required: true
+        type: string
+        description: Name of the deployment to update config for (e.g. nrel-commute)
+      user_email:
+        required: true
+        type: string
+        description: Email of the user triggering the workflow
+      script_name:
+        required: true
+        type: choice
+        options:
+          - update_admin_access
+      script_args:
+        required: false
+        type: string
+        description: Additional arguments for the script (space-separated)
+      token:
+        required: false
+        type: string
+        description: GitHub token for authentication. If not provided, the workflow will use the default token.
+
+env:
+  GITHUB_TOKEN: ${{ inputs.token || secrets.GITHUB_TOKEN }}
+
+jobs:
+  update_config:
+    runs-on: ubuntu-latest
+
+    outputs:
+      PR_URL: ${{ steps.commit_and_pr.outputs.PR_URL }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Create update branch
+        id: create_branch
+        run: |
+          BRANCH_NAME="config-update-${{ github.event.inputs.script_name }}-${{ github.run_id }}"
+          git checkout -b $BRANCH_NAME
+          echo "BRANCH_NAME=$BRANCH_NAME" >> "$GITHUB_OUTPUT"
+
+      - name: Run config update script
+        run: |
+          python bin/config_update/${{ inputs.script_name }}.py ${{ inputs.deployment }} ${{ inputs.script_args }}
+
+      - name: Commit and PR changes if needed
+        id: commit_and_pr
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+          git add .
+          git commit \
+            -m "[${{ inputs.deployment }}] ${{ inputs.script_name }}" \
+            -m "Updated [${{ inputs.deployment }}] configuration using \`${{ inputs.script_name }}\` with args \`${{ inputs.script_args }}\`" \
+            -m "This commit was generated by the \`config-update\` workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
+            -m "Triggered by admin user: ${{ inputs.user_email }}"
+          git push --set-upstream origin ${{ steps.create_branch.outputs.BRANCH_NAME }}
+          echo "Creating PR..."
+          PR_URL=$(gh pr create --base main --head ${{ steps.create_branch.outputs.BRANCH_NAME }} --fill)
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} gh pr merge "$PR_URL" --auto --squash
+          echo "PR created and will merge if checks pass: $PR_URL"

.github/workflows/issue-to-json.yml

@@ -14,16 +14,15 @@ jobs:
     if: contains( github.event.issue.title, 'New Project Configuration' )
     runs-on: ubuntu-latest
     steps:
-      # This step checks out a copy of your repository.
       - name: Check out repository
         uses: actions/checkout@v4
-      - name: install dependencies
-        shell: bash -l {0}
-        run: | 
-          npm install js-yaml
-          npm i @actions/core
-          npm i @actions/github
-      # This step references the directory that contains the action.
+      
+      - name: Install dependencies
+        run: npm i js-yaml @actions/core @actions/github
+      
+      - name: Create new branch
+        run: git checkout -b new-config-${{ github.event.issue.number }}
+      
       - name: Use local convertIssue action
         uses: ./.github/actions/convertIssue
         with:
@@ -33,27 +32,25 @@ jobs:
           issue-template: "add-new-config.yml"
           # This controls which property we use to key the file name
           hash-property-name: "url_abbreviation"
-      - name: Commit files
+      
+      - name: Generate token to authenticate as op-config-updates GitHub App
+        id: generate_token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.CONFIG_UPDATES_GH_APP_ID }}
+          private_key: ${{ secrets.CONFIG_UPDATES_GH_APP_PRIVATE_KEY }}
+      
+      - name: Commit and PR changes
+        env:
+          GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
         run: |
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
           git add configs/
-          git commit -m "Creating or updating file from form in issue #${{ env.IssueNumber }}"
-      - name: Create Pull Request
-        id: cpr
-        uses: peter-evans/create-pull-request@v5
-        with:
-          add-paths: |
-            configs/
-          commit-message: Create or update a new config file
-          signoff: false
-          branch: new-config-#${{ env.IssueNumber }}
-          delete-branch: false
-          title: '[Config #${{ env.IssueNumber }}] create new file'
-          body: |
-            Adding a new config file
-            - Initialized by creating or updating the coressponding issue
-            - Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/peter-evans/create-pull-request
-          draft: false
+          git commit \
+            -m "[${{ env.UrlAbbreviation }}] generate config from #${{ github.event.issue.number }}" \
+            -m "- Triggered by creating or updating #${{ github.event.issue.number }}" \
+            -m "- Auto-generated by the \`convert-issue-to-json\` workflow" \
+            -m "When merged, this will close #${{ github.event.issue.number }}"
+          git push --set-upstream origin new-config-${{ github.event.issue.number }}
+          gh pr create --base main --head new-config-${{ github.event.issue.number }} --fill

.github/workflows/validate-configs.yml

@@ -0,0 +1,31 @@
+name: Validate Configs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  validate_configs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Generate JSON schema with typescript-json-schema
+        run: |
+          npm install -g typescript-json-schema
+          npx typescript-json-schema index.d.ts DeploymentConfig --noExtraProps --required --out config.schema.json
+
+      - name: Validate all configs against config.schema.json
+        uses: cardinalby/schema-validator-action@v3
+        with:
+          file: 'configs/*.json'
+          schema: 'config.schema.json'

.gitignore

@@ -1,2 +1,4 @@
 .DS_Store
 .vscode/settings.json
+.env
+__pycache__

README.md

@@ -44,20 +44,20 @@ If you are here to test out the app on your personal phone, please use the open-
 
 In general, if you are planning to keep the app installed for less than a day, please use stage so you don't pollute the real dataset.
 
-#### Testing configs
+#### Testing local configs on e-mission-phone
 
-As we test more config options, we sometimes need to be able to edit and load configs locally without pushing to github
-and waiting for a PR to be approved.
+As we test more config options, we sometimes need to be able to test local config changes without pushing to GitHub and waiting for a PR to be approved.
 
 To accomplish this:
-- Change the download URL in `www/js/config/dynamic_config.js` to `"http://localhost:9090/configs/"+label+".nrel-op.json"`
-- Modify one of the existing configs **OR** create a new config and add it to `docs/index.html`
-- `docker-compose -f docker-compose.dev.yml up -d`
-- In the emulator, go to http://localhost:9090 and click on the appropriate link
+- Modify one of the existing configs in your local repo or create a new one (e.g. my-deployment.nrel-op.json)
+- `docker-compose -f docker-compose.dev.yml up -d` to serve your local configs on localhost:9090
+- With an emulator running e-mission-phone, log in with an opcode for that deployment (e.g. nrelop_my-deployment_1234)
+- As long as you are not using a 'production' build of e-mission-phone, the app will check localhost:9090 before it checks GitHub
+- You can use "Profile" > "Refresh App Configuration" to quickly test additional changes as long as "version" is incremented in your new version of the config
 
-### File format
+### Config options
 
-Config format (with default values) is:
+Example config format (with default values) is:
 
 ```
 {
@@ -95,13 +95,4 @@ Config format (with default values) is:
 }
 ```
 
-### Development
-
-This repo has some simple GitHub pages in the `docs` repo
-
-If you want to experiment with them (e.g. by changing the format or the URL
-prefix), you can use the attached `docker-compose.yml` to serve the pages
-locally at http://localhost:9090
-
-I found this useful while testing the QR code functionality on the devapp,
-which responds to the `emission` URL prefix, not `nrelopenpath`
+A TypeScript specification of all the available config options is available in `index.d.ts`.

bin/config_update/_util.py

@@ -0,0 +1,23 @@
+import os
+import sys
+import json
+
+
+def read_config(deployment):
+    config_file_path = f'configs/{deployment}.nrel-op.json'
+    if not os.path.exists(config_file_path):
+        print(f"There is no deployment called {deployment} - no changes made.")
+        sys.exit(1)
+    with open(config_file_path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+
+def update_config(deployment, new_config, msg):
+    config_file_path = f'configs/{deployment}.nrel-op.json'
+    if new_config and msg:
+        with open(config_file_path, 'w', encoding='utf-8') as f:
+            json.dump(new_config, f, indent=4, ensure_ascii=False)
+            f.write("\n")
+        print(f"Updated {config_file_path} with new config.")
+    else:
+        print("No changes made.")

bin/config_update/update_admin_access.py

@@ -0,0 +1,64 @@
+"""
+Add or remove admin email addresses from admin_dashboard.admin_access
+"""
+
+import sys
+import argparse
+import re
+
+from _util import read_config, update_config
+
+
+def add_admin_email(config, email):
+    if not re.match(r'^[\w\.-]+@[\w\.-]+\.\w{2,}$', email):
+        print(f"{email} is an invalid email format - no changes made.")
+        sys.exit(1)
+    
+    if email not in config.get('admin_dashboard', {}).get('admin_access', []):
+        if 'admin_dashboard' not in config:
+            config['admin_dashboard'] = {}
+        if 'admin_access' not in config['admin_dashboard']:
+            config['admin_dashboard']['admin_access'] = []
+        config['admin_dashboard']['admin_access'].append(email)
+        print(f"Added {email} to the admin_access list.")
+    else:
+        print(f"{email} is already an admin - no changes made.")
+        return
+
+    return config
+
+
+def remove_admin_email(config, email):
+    if email in config.get('admin_dashboard', {}).get('admin_access', []):
+        config['admin_dashboard']['admin_access'].remove(email)
+    else:
+        print(f"{email} is not an admin - no changes made.")
+        return
+
+    return config
+
+
+def update_admin_access(config, action, email):
+    new_config = None
+    if action == 'add':
+        new_config = add_admin_email(config, email)
+    elif action == 'remove':
+        new_config = remove_admin_email(config, email)
+
+    return new_config
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('deployment', type=str)
+    parser.add_argument('action', type=str, help='Action to perform (add/remove)')
+    parser.add_argument('email', type=str, help='Email address to add/remove')
+    args = parser.parse_args()
+
+    config = read_config(args.deployment)
+    new_config = update_admin_access(config, args.action, args.email)
+    if new_config:
+        msg = f"update admin_access\n\n - {args.action} {args.email}"
+        update_config(args.deployment, new_config, msg)
+    else:
+        print("No changes made.")

scripts/find_emails.py bin/find_emails.pyscripts/find_emails.py renamed to bin/find_emails.py

@@ -0,0 +1,15 @@
+const fs = require('fs');
+const path = require('path');
+
+const configsDir = path.join(process.cwd(), 'configs');
+
+fs.readdir(configsDir, (err, files) => {
+    files.forEach(file => {
+        const filePath = path.join(configsDir, file);
+        fs.readFile(filePath, 'utf-8', (err, data) => {
+            const jsonData = JSON.parse(data);
+            const formattedData = JSON.stringify(jsonData, null, 4) + '\n';
+            fs.writeFile(filePath, formattedData, 'utf-8', (err) => {});
+        });
+    });
+});