Rc 1.1.0

.github/workflows/push-release-tagged-server.yml

@@ -0,0 +1,45 @@
+name: Push Release Tagged Server
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  IMAGE_NAME: citrineos-server
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build image
+        run: docker build . --file ./Server/docker/Dockerfile --tag $IMAGE_NAME
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Push image
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/${IMAGE_NAME}
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          VERSION=$(echo $VERSION | sed -e 's/^v//')
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.github/workflows/test-build-server.yml

@@ -0,0 +1,20 @@
+name: Build Server on Pull Request
+
+on:
+  pull_request:
+
+env:
+  IMAGE_NAME: citrineos-server
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build image
+        run: docker build . --file ./Server/deploy.Dockerfile --tag $IMAGE_NAME

.gitignore

@@ -170,6 +170,9 @@ dist
 # TernJS port file
 .tern-port
 
+# Stores VSCode configurations
+.vscode
+
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
@@ -204,4 +207,99 @@ package-lock.json
 
 # PostgreSQL
 /Server/data/postgresql
-/Swarm/data/postgresql
+/Swarm/data/postgresql
+
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+#!.idea/codeStyles // todo potentially comment back in when vscode and intellij configs are supported
+#!.idea/runConfigurations // todo potentially comment back in when vscode and intellij configs are supported
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all
+
+data

00_Base/package.json

@@ -2,17 +2,17 @@
   "name": "@citrineos/base",
   "version": "1.0.0",
   "description": "The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "lib"
+    "dist"
   ],
   "scripts": {
     "prepublish": "npx eslint ./src",
-    "prepare": "npm run build",
-    "build": "tsc",
     "generate-interfaces": "node json-schema-processor.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "compile": "npm run clean && tsc -p tsconfig.json",
+    "clean": "rm -rf package-lock.json dist node_modules tsconfig.tsbuildinfo"
   },
   "keywords": [
     "ocpp",
@@ -37,5 +37,6 @@
     "tslog": "^4.9.2",
     "uuid": "^9.0.0",
     "zod": "^3.22.2"
-  }
+  },
+  "workspace": "../"
 }

00_Base/src/config/BootConfig.ts

@@ -28,4 +28,13 @@ export interface BootConfig {
      * Also declared in SystemConfig. If absent, SystemConfig value is used.
      */
     bootWithRejectedVariables?: boolean;
-}
+}
+
+/**
+ * Cache boot status is used to keep track of the overall boot process for Rejected or Pending.
+ * When Accepting a boot, blacklist needs to be cleared if and only if there was a previously 
+ * Rejected or Pending boot. When starting to configure charger, i.e. sending GetBaseReport or
+ * SetVariables, this should only be done if configuring is not still ongoing from a previous 
+ * BootNotificationRequest. Cache boot status mediates this behavior.
+ */
+export const BOOT_STATUS = "boot_status";

00_Base/src/config/defineConfig.ts

@@ -3,20 +3,93 @@
 //
 // SPDX-License-Identifier: Apache 2.0
 
-import { type SystemConfig, systemConfigSchema, SystemConfigInput } from "./types";
+import {type SystemConfig, SystemConfigInput, systemConfigSchema} from "./types";
 
+/**
+ * Defines the application configuration by merging input configuration which is defined in a file with environment variables.
+ * Takes environment variables over predefined
+ * @param inputConfig The file defined input configuration.
+ * @returns The final system configuration.
+ * @throws Error if required environment variables are not set or if there are parsing errors.
+ */
 export function defineConfig(inputConfig: SystemConfigInput): SystemConfig {
-    if (!inputConfig.data.sequelize.username) {
-        if (process.env.CITRINEOS_DB_USERNAME)
-            inputConfig.data.sequelize.username = process.env.CITRINEOS_DB_USERNAME;
-        else
-            throw new Error('CITRINEOS_DB_USERNAME must be set if username not provided in config');
+    const appConfig = mergeConfigFromEnvVars<SystemConfigInput>(inputConfig, process.env);
+
+    validateFinalConfig(appConfig);
+
+    return systemConfigSchema.parse(appConfig);
+}
+
+/**
+ * Finds a case-insensitive match for a key in an object.
+ * @param obj The object to search.
+ * @param targetKey The target key.
+ * @returns The matching key or undefined.
+ */
+function findCaseInsensitiveMatch<T>(obj: Record<string, T>, targetKey: string): string | undefined {
+    const lowerTargetKey = targetKey.toLowerCase();
+    return Object.keys(obj).find(key => key.toLowerCase() === lowerTargetKey);
+}
+
+/**
+ * Merges configuration from environment variables into the default configuration. Allows any to keep it as generic as possible.
+ * @param defaultConfig The default configuration.
+ * @param envVars The environment variables.
+ * @returns The merged configuration.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function mergeConfigFromEnvVars<T extends Record<string, any>>(defaultConfig: T, envVars: NodeJS.ProcessEnv): T {
+    const config: T = {...defaultConfig};
+
+    const prefix = "citrineos_";
+
+    for (const [fullEnvKey, value] of Object.entries(envVars)) {
+        if (!value) continue;
+        const lowercaseEnvKey = fullEnvKey.toLowerCase();
+        console.log(lowercaseEnvKey);
+        if (lowercaseEnvKey.startsWith(prefix)) {
+            const envKeyWithoutPrefix = lowercaseEnvKey.substring(prefix.length);
+            const path = envKeyWithoutPrefix.split('_');
+
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            let currentConfigPart: any = config;
+
+            for (let i = 0; i < path.length - 1; i++) {
+                const part = path[i];
+                const matchingKey = findCaseInsensitiveMatch(currentConfigPart, part);
+                if (matchingKey && typeof currentConfigPart[matchingKey] === 'object') {
+                    currentConfigPart = currentConfigPart[matchingKey];
+                } else {
+                    currentConfigPart[part] = {};
+                    currentConfigPart = currentConfigPart[part];
+                }
+            }
+
+            const finalPart = path[path.length - 1];
+            const keyToUse = findCaseInsensitiveMatch(currentConfigPart, finalPart) || finalPart;
+
+            try {
+                currentConfigPart[keyToUse] = JSON.parse(value as string);
+            } catch {
+                console.error(`Error parsing value '${value}' for environment variable '${fullEnvKey}'.`);
+                currentConfigPart[keyToUse] = value;
+            }
+        }
+    }
+    return config as T;
+}
+
+
+/**
+ * Validates the  system configuration to ensure required properties are set.
+ * @param finalConfig The final system configuration.
+ * @throws Error if required properties are not set.
+ */
+function validateFinalConfig(finalConfig: SystemConfigInput) {
+    if (!finalConfig.data.sequelize.username) {
+        throw new Error('CITRINEOS_DATA_SEQUELIZE_USERNAME must be set if username not provided in config');
     }
-    if (!inputConfig.data.sequelize.password) {
-        if (process.env.CITRINEOS_DB_PASSWORD)
-            inputConfig.data.sequelize.password = process.env.CITRINEOS_DB_PASSWORD;
-        else
-            throw new Error('CITRINEOS_DB_PASSWORD must be set if password not provided in config');
+    if (!finalConfig.data.sequelize.password) {
+        throw new Error('CITRINEOS_DATA_SEQUELIZE_PASSWORD must be set if password not provided in config');
     }
-    return systemConfigSchema.parse(inputConfig);
 }