@grnsft/if 1.0.2 → 1.1.0-beta.0

package/manifests/outputs/pipelines/scenario-3.yaml

@@ -0,0 +1,126 @@
+name: groupby
+description: successful path
+initialize:
+  plugins:
+    sum:
+      path: builtin
+      method: Sum
+      config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+execution:
+  command: >-
+    /usr/bin/node /home/mitsuru/if/build/if-run -m
+    manifests/examples/pipelines/scenario-3.yml -o
+    manifests/outputs/pipelines/scenario-3.yaml
+  environment:
+    if-version: 1.0.2
+    os: Ubuntu
+    os-version: 24.04.2 LTS
+    node-version: 18.19.1
+    date-time: 2025-06-02T14:32:40.906Z (UTC)
+    dependencies:
+      - '@grnsft/if-core@0.0.30'
+      - axios@1.8.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - express@5.1.0
+      - js-yaml@4.1.0
+      - luxon@3.4.4
+      - ts-command-line-args@2.5.1
+      - typescript-cubic-spline@1.0.1
+      - winston@3.11.0
+      - zod@3.23.8
+  status: success
+tree:
+  children:
+    my-app:
+      pipeline:
+        observe: null
+        regroup:
+          - cloud/instance-type
+          - cloud/region
+        compute: null
+      children:
+        uk-west:
+          children:
+            A1:
+              children:
+                uk-west:
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-west
+                      cpu/utilization: 99
+                    - timestamp: 2023-07-06T05:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-west
+                      cpu/utilization: 23
+                    - timestamp: 2023-07-06T10:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-west
+                      cpu/utilization: 12
+            B1:
+              children:
+                uk-west:
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-west
+                      cpu/utilization: 11
+                    - timestamp: 2023-07-06T05:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-west
+                      cpu/utilization: 67
+                    - timestamp: 2023-07-06T10:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-west
+                      cpu/utilization: 1
+        uk-east:
+          children:
+            A1:
+              children:
+                uk-east:
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-east
+                      cpu/utilization: 9
+                    - timestamp: 2023-07-06T05:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-east
+                      cpu/utilization: 23
+                    - timestamp: 2023-07-06T10:00
+                      duration: 300
+                      cloud/instance-type: A1
+                      cloud/region: uk-east
+                      cpu/utilization: 12
+            B1:
+              children:
+                uk-east:
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-east
+                      cpu/utilization: 11
+                    - timestamp: 2023-07-06T05:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-east
+                      cpu/utilization: 67
+                    - timestamp: 2023-07-06T10:00
+                      duration: 300
+                      cloud/instance-type: B1
+                      cloud/region: uk-east
+                      cpu/utilization: 1

package/openapi.yaml

@@ -0,0 +1,424 @@
+openapi: 3.0.3
+info:
+  title: Impact Framework Web API
+  description: |-
+    This API provides key feature of Impact Framework (IF) as a Web API.
+  license:
+    name: MIT license
+    url: https://github.com/Green-Software-Foundation/if/blob/main/LICENSE
+  version: 1.0.0
+externalDocs:
+  description: Find out more about Impact Framework
+  url: https://if.greensoftware.foundation/
+components:
+  schemas:
+    aggregation-method-type:
+      type: string
+      enum:
+        - sum
+        - avg
+        - none
+        - copy
+    aggregation-method:
+      type: object
+      properties:
+        time:
+          $ref: '#/components/schemas/aggregation-method-type'
+        component:
+          $ref: '#/components/schemas/aggregation-method-type'
+      required:
+        - time
+        - component
+      additionalProperties: false
+    aggregation-type:
+      type: string
+      enum:
+        - horizontal
+        - time
+        - vertical
+        - component
+        - both
+    metadata:
+      type: object
+      additionalProperties:
+        type: object
+        properties:
+          unit:
+            type: string
+          description:
+            type: string
+          aggregation-method:
+            $ref: '#/components/schemas/aggregation-method'
+        required:
+          - unit
+          - description
+          - aggregation-method
+        additionalProperties: false
+      nullable: true
+    parameter-metadata:
+      type: object
+      properties:
+        inputs:
+          $ref: '#/components/schemas/metadata'
+        outputs:
+          $ref: '#/components/schemas/metadata'
+      additionalProperties: false
+    manifest:
+      type: object
+      properties:
+        name:
+          type: string
+        description:
+          type: string
+          nullable: true
+        tags:
+          type: object
+          properties:
+            kind:
+              type: string
+              nullable: true
+            complexity:
+              type: string
+              nullable: true
+            category:
+              type: string
+              nullable: true
+          additionalProperties: false
+          nullable: true
+        explainer:
+          type: boolean
+        explain:
+          type: object
+        aggregation:
+          type: object
+          properties:
+            metrics:
+              type: array
+              items:
+                type: string
+            type:
+              $ref: '#/components/schemas/aggregation-type'
+            skip-components:
+              type: array
+              items:
+                type: string
+          required:
+            - metrics
+            - type
+          additionalProperties: false
+          nullable: true
+        initialize:
+          type: object
+          properties:
+            plugins:
+              type: object
+              additionalProperties:
+                type: object
+                properties:
+                  path:
+                    type: string
+                  method:
+                    type: string
+                  mapping:
+                    type: object
+                    additionalProperties:
+                      type: string
+                  config:
+                    type: object
+                  parameter-metadata:
+                    $ref: '#/components/schemas/parameter-metadata'
+                required:
+                  - path
+                  - method
+                additionalProperties: false
+          required:
+            - plugins
+          additionalProperties: false
+        execution:
+          type: object
+          properties:
+            command:
+              type: string
+            environment:
+              type: object
+              properties:
+                if-version:
+                  type: string
+                os:
+                  type: string
+                os-version:
+                  type: string
+                node-version:
+                  type: string
+                date-time:
+                  type: string
+                dependencies:
+                  type: array
+                  items:
+                    type: string
+              required:
+                - if-version
+                - os
+                - os-version
+                - node-version
+                - date-time
+                - dependencies
+              additionalProperties: false
+            status:
+              type: string
+            error:
+              type: string
+          required:
+            - status
+          additionalProperties: false
+        tree:
+          type: object
+      required:
+        - name
+        - initialize
+        - tree
+      additionalProperties: false
+  examples:
+    request-yaml:
+      summary: 'sample request YAML'
+      value:
+        name: demo
+        initialize:
+          plugins:
+            double-a-value:
+              path: 'builtin'
+              method: Coefficient
+              config:
+                input-parameter: "cpu/utilization"
+                coefficient: 2
+                output-parameter: "cpu-utilization-doubled"
+        tree:
+          children:
+            child-0:
+              pipeline:
+                compute:
+                  - double-a-value
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 1
+                  cpu/utilization: 20
+                - timestamp: 2023-07-06T00:01
+                  duration: 1
+                  cpu/utilization: 80
+    request-json:
+      summary: 'sample request JSON'
+      value:
+        {
+          "name": "demo",
+          "initialize": {
+            "plugins": {
+              "double-a-value": {
+                "path": "builtin",
+                "method": "Coefficient",
+                "config": {
+                  "input-parameter": "cpu/utilization",
+                  "coefficient": 2,
+                  "output-parameter": "cpu-utilization-doubled"
+                }
+              }
+            }
+          },
+          "tree": {
+            "children": {
+              "child-0": {
+                "pipeline": {
+                  "compute": [
+                    "double-a-value"
+                  ]
+                },
+                "inputs": [
+                  {
+                    "timestamp": "2023-07-06T00:00",
+                    "duration": 1,
+                    "cpu/utilization": 20
+                  },
+                  {
+                    "timestamp": "2023-07-06T00:01",
+                    "duration": 1,
+                    "cpu/utilization": 80
+                  }
+                ]
+              }
+            }
+          }
+        }
+    response-yaml:
+      summary: 'sample response YAML'
+      value:
+        name: demo
+        initialize:
+          plugins:
+            double-a-value:
+              path: builtin
+              method: Coefficient
+              config:
+                input-parameter: cpu/utilization
+                coefficient: 2
+                output-parameter: cpu-utilization-doubled
+        execution:
+          command: /usr/bin/node /usr/local/bin/if-api
+          environment:
+            if-version: 1.0.1
+            os: Ubuntu
+            os-version: 24.04.2 LTS
+            node-version: 18.19.1
+            date-time: 2025-05-08T06:26:22.727Z (UTC)
+            dependencies: []
+          status: success
+        tree:
+          children:
+            child-0:
+              pipeline:
+                compute:
+                  - double-a-value
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 1
+                  cpu/utilization: 20
+                - timestamp: 2023-07-06T00:01
+                  duration: 1
+                  cpu/utilization: 80
+              outputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 1
+                  cpu/utilization: 20
+                  cpu-utilization-doubled: 40
+                - timestamp: 2023-07-06T00:01
+                  duration: 1
+                  cpu/utilization: 80
+                  cpu-utilization-doubled: 160
+    response-json:
+      summary: 'sample response JSON'
+      value:
+        {
+          "name": "demo",
+          "initialize": {
+            "plugins": {
+              "double-a-value": {
+                "path": "builtin",
+                "method": "Coefficient",
+                "config": {
+                  "input-parameter": "cpu/utilization",
+                  "coefficient": 2,
+                  "output-parameter": "cpu-utilization-doubled"
+                }
+              }
+            }
+          },
+          "execution": {
+            "command": "/usr/bin/node /usr/local/bin/if-api",
+            "environment": {
+              "if-version": "1.0.1",
+              "os": "Ubuntu",
+              "os-version": "24.04.2 LTS",
+              "node-version": "18.19.1",
+              "date-time": "2025-05-08T06:30:00.855Z (UTC)",
+              "dependencies": []
+            },
+            "status": "success"
+          },
+          "tree": {
+            "children": {
+              "child-0": {
+                "pipeline": {
+                  "compute": [
+                    "double-a-value"
+                  ]
+                },
+                "inputs": [
+                  {
+                    "timestamp": "2023-07-06T00:00",
+                    "duration": 1,
+                    "cpu/utilization": 20
+                  },
+                  {
+                    "timestamp": "2023-07-06T00:01",
+                    "duration": 1,
+                    "cpu/utilization": 80
+                  }
+                ],
+                "outputs": [
+                  {
+                    "timestamp": "2023-07-06T00:00",
+                    "duration": 1,
+                    "cpu/utilization": 20,
+                    "cpu-utilization-doubled": 40
+                  },
+                  {
+                    "timestamp": "2023-07-06T00:01",
+                    "duration": 1,
+                    "cpu/utilization": 80,
+                    "cpu-utilization-doubled": 160
+                  }
+                ]
+              }
+            }
+          }
+        }
+paths:
+  /v1/run:
+    post:
+      summary: Execute `if-run` with given manifest.
+      operationId: ifRun
+      parameters:
+        - in: query
+          name: observe
+          schema:
+            type: boolean
+          required: false
+          description: "executes only observe pipeline of the manifest"
+        - in: query
+          name: aggregate
+          schema:
+            type: boolean
+          required: false
+          description: "executes only regroup pipeline of the manifest"
+        - in: query
+          name: compute
+          schema:
+            type: boolean
+          required: false
+          description: "executes only compute pipeline of the manifest"
+      requestBody:
+        description: IF Manifest
+        content:
+          application/yaml:
+            schema:
+              $ref: '#/components/schemas/manifest'
+            examples:
+              sample:
+                $ref: '#/components/examples/request-yaml'
+          application/json:
+            schema:
+              $ref: '#/components/schemas/manifest'
+            examples:
+              sample:
+                $ref: '#/components/examples/request-json'
+        required: true
+      responses:
+        '200':
+          description: Successful operation.
+          content:
+            application/yaml:
+              schema:
+                $ref: '#/components/schemas/manifest'
+              examples:
+                success:
+                  $ref: '#/components/examples/response-yaml'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/manifest'
+              examples:
+                success:
+                  $ref: '#/components/examples/response-json'
+        '400':
+          description: Validation Error
+        '415':
+          description: Invalid Content Type
+        '500':
+          description: Internal Server Error

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "1.0.2",
+  "version": "1.1.0-beta.0",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
@@ -12,7 +12,9 @@
     "if-env": "build/if-env/index.js",
     "if-check": "build/if-check/index.js",
     "if-csv": "build/if-csv/index.js",
-    "if-merge": "build/if-merge/index.js"
+    "if-merge": "build/if-merge/index.js",
+    "if-api": "build/if-api/index.js",
+    "if-metadata-check": "build/if-metadata-check/index.js"
   },
   "bugs": {
     "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
@@ -22,6 +24,7 @@
     "axios": "^1.7.2",
     "csv-parse": "^5.5.6",
     "csv-stringify": "^6.4.6",
+    "express": "^5.1.0",
     "js-yaml": "^4.1.0",
     "luxon": "^3.4.4",
     "ts-command-line-args": "^2.5.1",
@@ -35,6 +38,7 @@
     "@commitlint/cli": "^18.6.0",
     "@commitlint/config-conventional": "^18.6.0",
     "@jest/globals": "^29.6.1",
+    "@types/express": "^5.0.1",
     "@types/jest": "^29.5.7",
     "@types/js-yaml": "^4.0.5",
     "@types/luxon": "^3.4.2",
@@ -46,7 +50,7 @@
     "husky": "^8.0.0",
     "jest": "^29.6.1",
     "lint-staged": "^15.2.2",
-    "release-it": "^16.3.0",
+    "release-it": "^19.0.3",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
     "typescript": "^5.1.6"
@@ -79,6 +83,7 @@
     "coverage": "jest --verbose --coverage",
     "fix": "gts fix",
     "fix:package": "fixpack",
+    "if-api": "npx ts-node src/if-api/index.ts",
     "if-check": "cross-env CURRENT_DIR=$(node -p \"process.env.INIT_CWD\") npx ts-node src/if-check/index.ts",
     "if-csv": "cross-env CURRENT_DIR=$(node -p \"process.env.INIT_CWD\") npx ts-node src/if-csv/index.ts",
     "if-diff": "cross-env CURRENT_DIR=$(node -p \"process.env.INIT_CWD\") npx ts-node src/if-diff/index.ts",

package/with-plugins/Dockerfile

@@ -0,0 +1,59 @@
+ARG BUILDBASEIMAGE=ghcr.io/green-software-foundation/if
+ARG BASEIMAGE=node:18-slim
+
+FROM --platform=$BUILDPLATFORM $BUILDBASEIMAGE AS deps
+
+USER 0
+
+ARG PLUGINS=plugins.txt
+ARG NPMRC=.npmrc
+
+# Install additional plugins
+RUN --mount=src=.,target=settings \
+    --mount=type=cache,target=/root/.npm,sharing=locked \
+    if [ -r settings/$NPMRC -a -s settings/$NPMRC ]; then \
+        cp settings/$NPMRC /root/.npmrc; \
+    fi; \
+    npm install --no-fund $(cat settings/$PLUGINS); \
+    rm -f /root/.npmrc
+
+# Remove devDependencies
+RUN --mount=type=cache,target=/root/.npm,sharing=locked \
+    npm prune --ignore-scripts --omit=dev
+
+# Remove empty directory
+RUN rmdir --ignore-fail-on-non-empty node_modules/*
+
+
+FROM $BASEIMAGE
+
+# Packages to be installed
+ARG PACKAGES='git ca-certificates'
+
+# Install lsb_release, git and ca-certificates
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt-get update && \
+    apt-get --no-install-recommends install -y \
+    lsb-release $PACKAGES
+
+# Copy entrypoint shell script
+COPY --from=deps /usr/local/bin/docker-entrypoint.sh /usr/local/bin
+
+# Set execution user
+USER 1000
+
+# Create application directory
+WORKDIR /app
+
+# Copy application and runtime dependencies
+COPY --from=deps --chown=node:node /app .
+
+# Set environment variables
+ENV NODE_ENV=production NPM_CONFIG_UPDATE_NOTIFIER=false PATH=/app/node_modules/.bin:$PATH HOST=
+
+# Expose port
+EXPOSE 3000
+
+# Run the application
+CMD ["if-api"]