@grnsft/if 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.dockerignore +10 -0
- package/CONTAINER.md +148 -0
- package/Dockerfile +73 -0
- package/HELM_CHART.md +96 -0
- package/README.md +56 -0
- package/bin/docker-entrypoint.sh +15 -0
- package/build/common/types/manifest.d.ts +1 -0
- package/build/common/types/manifest.js +1 -1
- package/build/common/util/debug-logger.js +4 -18
- package/build/common/util/storage.d.ts +9 -0
- package/build/common/util/storage.js +24 -0
- package/build/if-api/config/config.d.ts +9 -0
- package/build/if-api/config/config.js +58 -0
- package/build/if-api/config/index.d.ts +2 -0
- package/build/if-api/config/index.js +8 -0
- package/build/if-api/config/strings.d.ts +16 -0
- package/build/if-api/config/strings.js +20 -0
- package/build/if-api/index.d.ts +2 -0
- package/build/if-api/index.js +268 -0
- package/build/if-api/types/process-args.d.ts +18 -0
- package/build/if-api/types/process-args.js +3 -0
- package/build/if-api/util/args.d.ts +5 -0
- package/build/if-api/util/args.js +42 -0
- package/build/if-metadata-check/config/config.d.ts +5 -0
- package/build/if-metadata-check/config/config.js +26 -0
- package/build/if-metadata-check/config/strings.d.ts +5 -0
- package/build/if-metadata-check/config/strings.js +9 -0
- package/build/if-metadata-check/index.d.ts +2 -0
- package/build/if-metadata-check/index.js +30 -0
- package/build/if-metadata-check/types/plugin.d.ts +7 -0
- package/build/if-metadata-check/types/plugin.js +3 -0
- package/build/if-metadata-check/types/process-args.d.ts +5 -0
- package/build/if-metadata-check/types/process-args.js +3 -0
- package/build/if-metadata-check/util/args.d.ts +57 -0
- package/build/if-metadata-check/util/args.js +29 -0
- package/build/if-metadata-check/util/metadata-checker.d.ts +44 -0
- package/build/if-metadata-check/util/metadata-checker.js +99 -0
- package/build/if-run/index.js +1 -1
- package/build/if-run/lib/aggregate.d.ts +2 -2
- package/build/if-run/lib/aggregate.js +5 -19
- package/build/if-run/lib/compute.d.ts +1 -1
- package/build/if-run/lib/compute.js +10 -9
- package/build/if-run/lib/environment.d.ts +5 -1
- package/build/if-run/lib/environment.js +21 -16
- package/build/if-run/lib/initialize.d.ts +12 -0
- package/build/if-run/lib/initialize.js +37 -3
- package/build/if-run/lib/regroup.d.ts +3 -2
- package/build/if-run/lib/regroup.js +13 -9
- package/build/if-run/types/compute.d.ts +1 -1
- package/build/if-run/types/compute.js +1 -1
- package/helm-chart/.helmignore +23 -0
- package/helm-chart/Chart.yaml +24 -0
- package/helm-chart/templates/NOTES.txt +22 -0
- package/helm-chart/templates/_helpers.tpl +62 -0
- package/helm-chart/templates/additionalPlugins.yaml +13 -0
- package/helm-chart/templates/deployment.yaml +144 -0
- package/helm-chart/templates/disabledPlugins.yaml +11 -0
- package/helm-chart/templates/env-configmap.yaml +10 -0
- package/helm-chart/templates/env-secret.yaml +10 -0
- package/helm-chart/templates/hpa.yaml +32 -0
- package/helm-chart/templates/ingress.yaml +43 -0
- package/helm-chart/templates/npmrc.yaml +11 -0
- package/helm-chart/templates/service.yaml +24 -0
- package/helm-chart/templates/serviceaccount.yaml +13 -0
- package/helm-chart/templates/tests/test-connection.yaml +15 -0
- package/helm-chart/values.yaml +175 -0
- package/manifests/examples/bugs/aggregation-error-wrong-metric.yml +173 -0
- package/manifests/examples/bugs/input-error-missing-duration.yml +25 -0
- package/manifests/examples/bugs/mock-observations-failure-duration-is-zero.yml +33 -0
- package/manifests/examples/bugs/pipeline-error-naming-mismatch.yml +32 -0
- package/manifests/examples/bugs/pipeline-error-uninitialized-plugin.yml +33 -0
- package/manifests/examples/bugs/pipeline-ordering-error.yml +91 -0
- package/manifests/examples/builtins/divide/success-denominator-equal-zero.yml +36 -0
- package/manifests/examples/builtins/mock-observations/failure-invalid-config-cpu-range.yml +0 -1
- package/manifests/examples/builtins/mock-observations/failure-invalid-memory-utilization-range.yml +0 -1
- package/manifests/examples/builtins/mock-observations/failure-missing-timestamp-from-param.yml +0 -1
- package/manifests/examples/builtins/mock-observations/success.yml +0 -1
- package/manifests/examples/builtins/sci/failure-invalid-config-value.yml +0 -1
- package/manifests/examples/builtins/sci/failure-missing-input-param.yml +0 -1
- package/manifests/examples/builtins/sci/success.yml +0 -1
- package/manifests/examples/builtins/sci-embodied/failure-invalid-default-emission-value.yml +22 -0
- package/manifests/examples/builtins/time-sync/failure-missing-config.yml +0 -2
- package/manifests/examples/builtins/time-sync/success.yml +0 -2
- package/manifests/examples/features/aggregate-failure-invalid-metrics.yml +50 -0
- package/manifests/examples/features/aggregate-failure-missing-metric-in-inputs.yml +50 -0
- package/manifests/examples/features/aggregate-horizontal.yml +58 -0
- package/manifests/examples/features/aggregate-vertical.yml +58 -0
- package/manifests/examples/features/aggregate.yml +58 -0
- package/manifests/examples/pipelines/cloud-metadata-divide.yml +36 -0
- package/manifests/examples/pipelines/pipeline-with-mocks.yml +0 -1
- package/manifests/examples/pipelines/scenario-5.yml +0 -1
- package/manifests/outputs/bugs/mock-observations-failure-duration-is-zero.yaml +0 -1
- package/manifests/outputs/builtins/mock-observations/failure-invalid-config-cpu-range.yaml +0 -1
- package/manifests/outputs/builtins/mock-observations/failure-invalid-memory-utilization-range.yaml +0 -1
- package/manifests/outputs/builtins/mock-observations/failure-missing-timestamp-from-param.yaml +0 -1
- package/manifests/outputs/builtins/sci/failure-invalid-config-value.yaml +0 -1
- package/manifests/outputs/builtins/sci/failure-missing-input-param.yaml +0 -1
- package/manifests/outputs/builtins/time-sync/failure-missing-config.yaml +0 -2
- package/manifests/outputs/features/regroup/success.yaml +72 -0
- package/manifests/outputs/pipelines/pipeline-with-aggregate.yaml +1291 -0
- package/manifests/outputs/pipelines/scenario-3.yaml +126 -0
- package/openapi.yaml +424 -0
- package/package.json +8 -3
- package/with-plugins/Dockerfile +59 -0
- package/manifests/outputs/builtins/interpolation/interpolation.yaml +0 -81
- package/manifests/outputs/features/failure-invalid-regroup.yaml +0 -87
- package/manifests/outputs/features/failure-missing-cloud-instance-type.yaml +0 -86
package/.dockerignore
ADDED
package/CONTAINER.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Using Docker Container
|
|
2
|
+
|
|
3
|
+
The Impact Framework API server can be run as a Docker container.
|
|
4
|
+
The official image is provided at `ghcr.io/green-software-foundation/if`.
|
|
5
|
+
|
|
6
|
+
## Running the Container
|
|
7
|
+
|
|
8
|
+
Run a container using the built image:
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
# Run with default port (3000)
|
|
12
|
+
$ docker run --rm -p 3000:3000 ghcr.io/green-software-foundation/if
|
|
13
|
+
|
|
14
|
+
# Run with custom port
|
|
15
|
+
$ docker run --rm -p 8080:3000 ghcr.io/green-software-foundation/if
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
When specifying arguments for the `if-api` command, you need to include the `if-api` command as shown below.
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
# Run without external plugin warning
|
|
22
|
+
$ docker run --rm -p 3000:3000 ghcr.io/green-software-foundation/if if-api --disableExternalPluginWarning
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Using the containerized API server
|
|
26
|
+
|
|
27
|
+
The containerized API server provides the same endpoints as the regular API server:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
# Process manifest
|
|
31
|
+
$ curl -H "Content-Type: application/yaml" --data-binary @manifest.yaml http://localhost:3000/v1/run
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Adding external plugins at startup
|
|
35
|
+
You can add any external plugins at startup by mounting a file that lists the plugins to `/app/plugins.txt`.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
$ cat plugins.txt
|
|
39
|
+
carbon-intensity-plugin
|
|
40
|
+
Green-Software-Foundation/if-github-plugin
|
|
41
|
+
$ docker run --rm -p 3000:3000 -v $(pwd)/plugins.txt:/app/plugins.txt ghcr.io/green-software-foundation/if
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The contents of `/app/plugins.txt` are used directly as arguments for `npm install`.
|
|
45
|
+
For available formats, refer to: https://docs.npmjs.com/cli/v8/commands/npm-install
|
|
46
|
+
|
|
47
|
+
If the plugin itself or packages it depends on are private, you'll need to mount an `.npmrc` file at `/app/.npmrc` for the access token required to install packages.
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
$ cat plugins.txt
|
|
51
|
+
@myscope/myplugin
|
|
52
|
+
$ cat .npmrc
|
|
53
|
+
//registry.npmjs.org/:_authToken=<YOUR_AUTH_TOKEN>
|
|
54
|
+
@myscope:registry=https://registry.npmjs.org/
|
|
55
|
+
$ docker run --rm -p 3000:3000 -v $(pwd)/plugins.txt:/app/plugins.txt -v $(pwd)/.npmrc:/app/.npmrc ghcr.io/green-software-foundation/if
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
For `.npmrc` format reference: https://docs.npmjs.com/cli/v8/configuring-npm/npmrc
|
|
59
|
+
|
|
60
|
+
Note that if the plugin itself or packages it depends on are in GitHub Packages, a personal access token (classic) with `read:packages` permission is required even for public packages.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
$ cat plugins.txt
|
|
64
|
+
danuw/if-casdk-plugin
|
|
65
|
+
$ cat .npmrc
|
|
66
|
+
//npm.pkg.github.com/:_authToken=<YOUR_PERSONAL_ACCESS_TOKEN>
|
|
67
|
+
@Green-Software-Foundation:registry=https://npm.pkg.github.com/
|
|
68
|
+
$ docker run --rm -p 3000:3000 -v $(pwd)/plugins.txt:/app/plugins.txt -v $(pwd)/.npmrc:/app/.npmrc ghcr.io/green-software-foundation/if
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Alternatively, the access token can also be extracted to an environment variable (but this is not recommended as it can easily leak through `ps` commands, `proc` filesystem, dumps, etc.).
|
|
72
|
+
|
|
73
|
+
```sh
|
|
74
|
+
$ cat plugins.txt
|
|
75
|
+
@myscope/myplugin
|
|
76
|
+
$ cat .npmrc
|
|
77
|
+
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
|
|
78
|
+
@myscope:registry=https://registry.npmjs.org/
|
|
79
|
+
$ docker run --rm -p 3000:3000 -v $(pwd)/plugins.txt:/app/plugins.txt -e NODE_AUTH_TOKEN=<YOUR_AUTH_TOKEN> -v $(pwd)/.npmrc:/app/.npmrc ghcr.io/green-software-foundation/if
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Building the Container Image
|
|
83
|
+
|
|
84
|
+
As mentioned above, there are official images available, but you can also build your own container image using the provided `Dockerfile`:
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
# Build the container image
|
|
88
|
+
$ docker build -t myorg/if:v1.0.0 .
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Building Slim Image
|
|
92
|
+
|
|
93
|
+
The built container image includes the git command to enable installation of external plugins from git repositories such as GitHub at startup.
|
|
94
|
+
However, if you know that you don't need to install external plugins from git repositories during startup, you can create a slimmer container image without git by specifying the `--build-arg PACKAGES=` option in the container image build command.
|
|
95
|
+
|
|
96
|
+
```sh
|
|
97
|
+
# Build custom image without git
|
|
98
|
+
$ docker build -t myorg/if:v1.0.0-slim --build-arg PACKAGES= .
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Note that the absence of git does not affect the installation of npm packages.
|
|
102
|
+
|
|
103
|
+
```sh
|
|
104
|
+
# Run the custom image with the npm package
|
|
105
|
+
$ cat plugins-startup.txt
|
|
106
|
+
carbon-intensity-plugin
|
|
107
|
+
$ docker run --rm -p 3000:3000 -v $(pwd)/plugins-startup.txt:/app/plugins.txt myorg/if:v1.0.0-slim
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Building the Container Image with external plugins
|
|
111
|
+
|
|
112
|
+
While the official image and images built using the methods described above can add external plugins at container startup, installing external plugins takes considerable time, which significantly slows down container startup.
|
|
113
|
+
To avoid this, a `Dockerfile` for building container images with external plugins pre-installed is also provided in the `with-plugins` directory.
|
|
114
|
+
Create a `with-plugins/plugins.txt` file and build the image.
|
|
115
|
+
|
|
116
|
+
```sh
|
|
117
|
+
$ cat with-plugins/plugins.txt
|
|
118
|
+
carbon-intensity-plugin
|
|
119
|
+
Green-Software-Foundation/if-github-plugin
|
|
120
|
+
$ docker build -t myorg/if-with-plugins:v1.0.0 with-plugins
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
A `with-plugins/.npmrc` is required if you need an access token, as well as if you want to add external plugins when starting the container (The `with-plugins/.npmrc` file will not remain in the container image).
|
|
124
|
+
|
|
125
|
+
```sh
|
|
126
|
+
$ cat with-plugins/plugins.txt
|
|
127
|
+
danuw/if-casdk-plugin
|
|
128
|
+
$ cat with-plugins/.npmrc
|
|
129
|
+
//npm.pkg.github.com/:_authToken=<YOUR_PERSONAL_ACCESS_TOKEN>
|
|
130
|
+
@Green-Software-Foundation:registry=https://npm.pkg.github.com/
|
|
131
|
+
$ docker build -t myorg/if-with-plugins:v1.0.0 with-plugins
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
The base image used for installing external plugins is the official image, and the base image for the final image is `node:18-slim`, but these can be changed using the `BUILDBASEIMAGE` and `BASEIMAGE` arguments respectively.
|
|
135
|
+
|
|
136
|
+
```sh
|
|
137
|
+
$ docker build -t myorg/if-with-plugins:v1.0.0 --build-arg BUILDBASEIMAGE=myorg/if:v1.0.0 --build-arg BASEIMAGE=node:20-slim with-plugins
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Note that, as with regular images, you can also create a slim image without git by adding the `--build-arg PACKAGES=` option.
|
|
141
|
+
|
|
142
|
+
## Execution Other Than API Server
|
|
143
|
+
|
|
144
|
+
The container image can execute commands other than the `if-api` command.
|
|
145
|
+
|
|
146
|
+
```sh
|
|
147
|
+
$ docker run --rm -v $(pwd)/manifests/examples/pipelines/sci.yml:/app/sci.yml myorg/if:v1.0.0 if-run -m sci.yml
|
|
148
|
+
```
|
package/Dockerfile
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
ARG BASEIMAGE=node:18-slim
|
|
2
|
+
|
|
3
|
+
FROM --platform=$BUILDPLATFORM $BASEIMAGE AS deps
|
|
4
|
+
|
|
5
|
+
# Install git and ca-certificates
|
|
6
|
+
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
7
|
+
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
8
|
+
apt-get update && \
|
|
9
|
+
apt-get --no-install-recommends install -y \
|
|
10
|
+
git ca-certificates
|
|
11
|
+
|
|
12
|
+
# Create application directory
|
|
13
|
+
WORKDIR /app
|
|
14
|
+
|
|
15
|
+
# Copy package*.json
|
|
16
|
+
COPY package*.json .
|
|
17
|
+
|
|
18
|
+
# Install build dependencies
|
|
19
|
+
RUN --mount=type=cache,target=/root/.npm,sharing=locked \
|
|
20
|
+
npm ci --ignore-scripts --no-fund
|
|
21
|
+
|
|
22
|
+
# Compile TypeScript
|
|
23
|
+
RUN --mount=src=tsconfig.json,target=tsconfig.json \
|
|
24
|
+
--mount=src=tsconfig.build.json,target=tsconfig.build.json \
|
|
25
|
+
--mount=src=src/,target=src/ \
|
|
26
|
+
npm run build
|
|
27
|
+
|
|
28
|
+
# Remove devDependencies
|
|
29
|
+
RUN --mount=type=cache,target=/root/.npm,sharing=locked \
|
|
30
|
+
npm prune --ignore-scripts --omit=dev
|
|
31
|
+
|
|
32
|
+
# Remove empty directory
|
|
33
|
+
RUN rmdir --ignore-fail-on-non-empty node_modules/*
|
|
34
|
+
|
|
35
|
+
# Set executable attributes to applications
|
|
36
|
+
RUN chmod +x build/if-*/index.js
|
|
37
|
+
|
|
38
|
+
# Link applications
|
|
39
|
+
RUN for a in build/if-*/index.js; do ln -s ../../$a node_modules/.bin/$(basename $(dirname $a)); done
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
FROM $BASEIMAGE
|
|
43
|
+
|
|
44
|
+
# Packages to be installed
|
|
45
|
+
ARG PACKAGES='git ca-certificates'
|
|
46
|
+
|
|
47
|
+
# Install lsb_release, git and ca-certificates
|
|
48
|
+
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
49
|
+
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
50
|
+
apt-get update && \
|
|
51
|
+
apt-get --no-install-recommends install -y \
|
|
52
|
+
lsb-release $PACKAGES
|
|
53
|
+
|
|
54
|
+
# Copy entrypoint shell script
|
|
55
|
+
COPY bin/docker-entrypoint.sh /usr/local/bin
|
|
56
|
+
|
|
57
|
+
# Set execution user
|
|
58
|
+
USER 1000
|
|
59
|
+
|
|
60
|
+
# Create application directory
|
|
61
|
+
WORKDIR /app
|
|
62
|
+
|
|
63
|
+
# Copy application and runtime dependencies
|
|
64
|
+
COPY --from=deps --chown=node:node /app .
|
|
65
|
+
|
|
66
|
+
# Set environment variables
|
|
67
|
+
ENV NODE_ENV=production NPM_CONFIG_UPDATE_NOTIFIER=false PATH=/app/node_modules/.bin:$PATH HOST=
|
|
68
|
+
|
|
69
|
+
# Expose port
|
|
70
|
+
EXPOSE 3000
|
|
71
|
+
|
|
72
|
+
# Run the application
|
|
73
|
+
CMD ["if-api"]
|
package/HELM_CHART.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Using API server with Kubernetes
|
|
2
|
+
|
|
3
|
+
The Impact Framework provides a helm chart, making it easy to run on a Kubernetes cluster.
|
|
4
|
+
|
|
5
|
+
## Deploy the API server to Kubernetes
|
|
6
|
+
|
|
7
|
+
The helm chart is provided in OCI format on GitHub Container Registry, so you need to specify `oci:` when referencing the chart.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
$ helm install if oci://ghcr.io/green-software-foundation/charts/if
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
For security reasons, three builtin plugins (Shell, CSVImport, CSVLookup) are disabled by default, but they can be enabled by specifying in `values.yaml`.
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
# enable all builtin plugins
|
|
17
|
+
disabledPlugins: []
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Install External Plugins
|
|
21
|
+
|
|
22
|
+
You can also specify in `values.yaml` to install external plugins when the pod starts.
|
|
23
|
+
|
|
24
|
+
```yaml
|
|
25
|
+
additionalPlugins:
|
|
26
|
+
- carbon-intensity-plugin
|
|
27
|
+
- Green-Software-Foundation/if-github-plugin
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
If an `.npmrc` file is required, you can create a `Secret` by specifying it in the `npmrc` section of the `values.yaml` file.
|
|
31
|
+
|
|
32
|
+
```yaml
|
|
33
|
+
additionalPlugins:
|
|
34
|
+
- Green-Software-Foundation/community-plugins
|
|
35
|
+
- danuw/if-casdk-plugin
|
|
36
|
+
|
|
37
|
+
npmrc: |
|
|
38
|
+
//npm.pkg.github.com/:_authToken=<YOUR_PERSONAL_ACCESS_TOKEN>
|
|
39
|
+
@Green-Software-Foundation:registry=https://npm.pkg.github.com/
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
You can also extract the access token as an environment variable.
|
|
43
|
+
|
|
44
|
+
```yaml
|
|
45
|
+
additionalPlugins:
|
|
46
|
+
- Green-Software-Foundation/community-plugins
|
|
47
|
+
- danuw/if-casdk-plugin
|
|
48
|
+
|
|
49
|
+
npmrc: |
|
|
50
|
+
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
|
|
51
|
+
@Green-Software-Foundation:registry=https://npm.pkg.github.com/
|
|
52
|
+
|
|
53
|
+
env:
|
|
54
|
+
secret:
|
|
55
|
+
GITHUB_TOKEN: <YOUR_PERSONAL_ACCESS_TOKEN>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Using Custom Container Images
|
|
59
|
+
|
|
60
|
+
By creating and using a container image with external plugins pre-installed, you can use external plugins without installing them at pod startup, which reduces pod startup time.
|
|
61
|
+
|
|
62
|
+
`values.yaml` for using `my-image-repository:my-version` as the container image:
|
|
63
|
+
|
|
64
|
+
```yaml
|
|
65
|
+
image:
|
|
66
|
+
repository: my-image-repository
|
|
67
|
+
tag: my-version
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Using Kubernetes service
|
|
71
|
+
|
|
72
|
+
By default, a `ClusterIP` service is deployed, so you can access the API server by running `kubectl port-forward`.
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
$ kubectl port-forward svc/if 3000:3000 &
|
|
76
|
+
$ curl -H "Content-Type: application/yaml" --data-binary @manifest.yaml http://localhost:3000/v1/run
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
You can access the API server from outside the cluster without using `port-forward` by changing the service type to `NodePort` or `LoadBalancer`.
|
|
80
|
+
|
|
81
|
+
`values.yaml` for the `NodePort`:
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
# Using NodePort
|
|
85
|
+
service:
|
|
86
|
+
type: NodePort
|
|
87
|
+
nodePort: 32000
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
`values.yaml` for the `LoadBalancer`:
|
|
91
|
+
|
|
92
|
+
```yaml
|
|
93
|
+
# Using LoadBalancer
|
|
94
|
+
service:
|
|
95
|
+
type: LoadBalancer
|
|
96
|
+
```
|
package/README.md
CHANGED
|
@@ -60,6 +60,62 @@ if-run --help
|
|
|
60
60
|
if-run -h
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
+
### Using API server
|
|
64
|
+
|
|
65
|
+
The Impact Framework also provides an API server. By default, it listens on localhost:3000, but this can be changed.
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
# Run the API server listening on the default localhost:3000.
|
|
69
|
+
$ if-api
|
|
70
|
+
|
|
71
|
+
# Run the API server listening on 0.0.0.0:8080.
|
|
72
|
+
$ if-api --host 0.0.0.0 --port 8080
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
If the API server is running, you can send a manifest in the request body and receive the results of `if-run` as a response.
|
|
76
|
+
|
|
77
|
+
```sh
|
|
78
|
+
# Process manifest
|
|
79
|
+
$ curl -H "Content-Type: application/yaml" --data-binary @manifest.yaml http://localhost:3000/v1/run
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Note that in `if-api`, the following builtin plugins are disabled by default for security reasons.
|
|
83
|
+
- Shell
|
|
84
|
+
- CSVImport
|
|
85
|
+
- CSVLookup
|
|
86
|
+
|
|
87
|
+
Please refer to the documentation for detailed usage instructions, including how to enable these plugins.
|
|
88
|
+
|
|
89
|
+
### Using Docker Container
|
|
90
|
+
|
|
91
|
+
The Impact Framework API server can also be run as a Docker container.
|
|
92
|
+
The official image is provided at `ghcr.io/green-software-foundation/if`, so you can run the container with the following command.
|
|
93
|
+
|
|
94
|
+
```sh
|
|
95
|
+
# Run with default port (3000)
|
|
96
|
+
$ docker run --rm -p 3000:3000 ghcr.io/green-software-foundation/if
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Please refer to [`CONTAINER.md`](CONTAINER.md) for how to install external plugins during container execution and how to build custom images.
|
|
100
|
+
|
|
101
|
+
### Using API server with Kubernetes
|
|
102
|
+
|
|
103
|
+
The Impact Framework also provides a helm chart for running the API server on a Kubernetes cluster.
|
|
104
|
+
The helm chart is provided in OCI format on GitHub Container Registry, so you need to specify `oci:` when referencing the chart.
|
|
105
|
+
|
|
106
|
+
```sh
|
|
107
|
+
$ helm install if oci://ghcr.io/green-software-foundation/charts/if
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
By default, a `ClusterIP` service is deployed, so you can access the API server by running `kubectl port-forward`.
|
|
111
|
+
|
|
112
|
+
```sh
|
|
113
|
+
$ kubectl port-forward svc/if 3000:3000 &
|
|
114
|
+
$ curl -H "Content-Type: application/yaml" --data-binary @manifest.yaml http://localhost:3000/v1/run
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
For detailed usage including external plugin installation and NodePort configuration, please refer to [`HELM_CHART.md`](HELM_CHART.md).
|
|
118
|
+
|
|
63
119
|
## Documentation
|
|
64
120
|
|
|
65
121
|
Please read our documentation at [if.greensoftware.foundation](https://if.greensoftware.foundation/)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
set -e
|
|
3
|
+
|
|
4
|
+
# Install plugins if plugins.txt exists.
|
|
5
|
+
if [ -f plugins.txt ] && [ -r plugins.txt ]; then
|
|
6
|
+
echo "Installing plugins..."
|
|
7
|
+
npm install --no-fund $(cat plugins.txt)
|
|
8
|
+
fi
|
|
9
|
+
|
|
10
|
+
# Run command with node if the first argument contains a "-" or is not a system command.
|
|
11
|
+
if [ "${1#-}" != "${1}" ] || [ -z "$(command -v "${1}")" ] || { [ -f "${1}" ] && ! [ -x "${1}" ]; } || [ -d "${1}" ]; then
|
|
12
|
+
set -- node "$@"
|
|
13
|
+
fi
|
|
14
|
+
|
|
15
|
+
exec "$@"
|
|
@@ -2,6 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
import { AggregationOptions } from '@grnsft/if-core/types';
|
|
3
3
|
import { manifestSchema } from '../util/validations';
|
|
4
4
|
export type Manifest = z.infer<typeof manifestSchema>;
|
|
5
|
+
export type Execution = NonNullable<Manifest['execution']>;
|
|
5
6
|
export type GlobalPlugins = Manifest['initialize']['plugins'];
|
|
6
7
|
export type PluginOptions = GlobalPlugins[string];
|
|
7
8
|
export type AggregationParams = Manifest['aggregation'];
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFuaWZlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29tbW9uL3R5cGVzL21hbmlmZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge3p9IGZyb20gJ3pvZCc7XG5pbXBvcnQge0FnZ3JlZ2F0aW9uT3B0aW9uc30gZnJvbSAnQGdybnNmdC9pZi1jb3JlL3R5cGVzJztcblxuaW1wb3J0IHttYW5pZmVzdFNjaGVtYX0gZnJvbSAnLi4vdXRpbC92YWxpZGF0aW9ucyc7XG5cbmV4cG9ydCB0eXBlIE1hbmlmZXN0ID0gei5pbmZlcjx0eXBlb2YgbWFuaWZlc3RTY2hlbWE+O1xuXG5leHBvcnQgdHlwZSBHbG9iYWxQbHVnaW5zID0gTWFuaWZlc3RbJ2luaXRpYWxpemUnXVsncGx1Z2lucyddO1xuXG5leHBvcnQgdHlwZSBQbHVnaW5PcHRpb25zID0gR2xvYmFsUGx1Z2luc1tzdHJpbmddO1xuXG5leHBvcnQgdHlwZSBBZ2dyZWdhdGlvblBhcmFtcyA9IE1hbmlmZXN0WydhZ2dyZWdhdGlvbiddO1xuZXhwb3J0IHR5cGUgQWdncmVnYXRpb25NZXRyaWNzV2l0aE1ldGhvZCA9IHtcbiAgW2tleTogc3RyaW5nXTogQWdncmVnYXRpb25PcHRpb25zO1xufTtcblxuZXhwb3J0IHR5cGUgQWdncmVnYXRpb25QYXJhbXNTdXJlID0gRXh0cmFjdDxNYW5pZmVzdFsnYWdncmVnYXRpb24nXSwge30+O1xuXG5leHBvcnQgdHlwZSBDb250ZXh0ID0gT21pdDxNYW5pZmVzdCwgJ3RyZWUnPjtcblxuZXhwb3J0IHR5cGUgQ29udGV4dFdpdGhFeGVjID0gT21pdDxNYW5pZmVzdCwgJ3RyZWUnPjtcbiJdfQ==
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFuaWZlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29tbW9uL3R5cGVzL21hbmlmZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge3p9IGZyb20gJ3pvZCc7XG5pbXBvcnQge0FnZ3JlZ2F0aW9uT3B0aW9uc30gZnJvbSAnQGdybnNmdC9pZi1jb3JlL3R5cGVzJztcblxuaW1wb3J0IHttYW5pZmVzdFNjaGVtYX0gZnJvbSAnLi4vdXRpbC92YWxpZGF0aW9ucyc7XG5cbmV4cG9ydCB0eXBlIE1hbmlmZXN0ID0gei5pbmZlcjx0eXBlb2YgbWFuaWZlc3RTY2hlbWE+O1xuXG5leHBvcnQgdHlwZSBFeGVjdXRpb24gPSBOb25OdWxsYWJsZTxNYW5pZmVzdFsnZXhlY3V0aW9uJ10+O1xuXG5leHBvcnQgdHlwZSBHbG9iYWxQbHVnaW5zID0gTWFuaWZlc3RbJ2luaXRpYWxpemUnXVsncGx1Z2lucyddO1xuXG5leHBvcnQgdHlwZSBQbHVnaW5PcHRpb25zID0gR2xvYmFsUGx1Z2luc1tzdHJpbmddO1xuXG5leHBvcnQgdHlwZSBBZ2dyZWdhdGlvblBhcmFtcyA9IE1hbmlmZXN0WydhZ2dyZWdhdGlvbiddO1xuZXhwb3J0IHR5cGUgQWdncmVnYXRpb25NZXRyaWNzV2l0aE1ldGhvZCA9IHtcbiAgW2tleTogc3RyaW5nXTogQWdncmVnYXRpb25PcHRpb25zO1xufTtcblxuZXhwb3J0IHR5cGUgQWdncmVnYXRpb25QYXJhbXNTdXJlID0gRXh0cmFjdDxNYW5pZmVzdFsnYWdncmVnYXRpb24nXSwge30+O1xuXG5leHBvcnQgdHlwZSBDb250ZXh0ID0gT21pdDxNYW5pZmVzdCwgJ3RyZWUnPjtcblxuZXhwb3J0IHR5cGUgQ29udGV4dFdpdGhFeGVjID0gT21pdDxNYW5pZmVzdCwgJ3RyZWUnPjtcbiJdfQ==
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.debugLogger = void 0;
|
|
4
|
+
const storage_1 = require("../../common/util/storage");
|
|
4
5
|
const config_1 = require("../../if-run/config");
|
|
5
6
|
const logMessagesKeys = [
|
|
6
7
|
'STARTING_IF',
|
|
@@ -46,26 +47,11 @@ const overrideConsoleMethods = (debugMode) => {
|
|
|
46
47
|
console.error = (...args) => debugLog(LogLevel.Error, args, debugMode);
|
|
47
48
|
console.debug = (...args) => debugLog(LogLevel.Debug, args, debugMode);
|
|
48
49
|
};
|
|
49
|
-
/**
|
|
50
|
-
* Creates an encapsulated object to retrieve the plugin name.
|
|
51
|
-
*/
|
|
52
|
-
const pluginNameManager = (() => {
|
|
53
|
-
let pluginName = '';
|
|
54
|
-
const manager = {
|
|
55
|
-
get currentPluginName() {
|
|
56
|
-
return pluginName;
|
|
57
|
-
},
|
|
58
|
-
set currentPluginName(value) {
|
|
59
|
-
pluginName = value;
|
|
60
|
-
},
|
|
61
|
-
};
|
|
62
|
-
return manager;
|
|
63
|
-
})();
|
|
64
50
|
/**
|
|
65
51
|
* Sets the name of the currently executing plugin.
|
|
66
52
|
*/
|
|
67
53
|
const setExecutingPluginName = (pluginName) => {
|
|
68
|
-
|
|
54
|
+
(0, storage_1.getStorage)().currentPluginName = pluginName;
|
|
69
55
|
};
|
|
70
56
|
/**
|
|
71
57
|
* Logs messages with the specified log level and format.
|
|
@@ -96,7 +82,7 @@ const debugLog = (level, args, debugMode) => {
|
|
|
96
82
|
return;
|
|
97
83
|
}
|
|
98
84
|
const date = new Date().toISOString();
|
|
99
|
-
const plugin =
|
|
85
|
+
const plugin = (0, storage_1.getStorage)().currentPluginName;
|
|
100
86
|
const isExeption = typeof args[0] === 'string' && args[0].includes('**Computing');
|
|
101
87
|
const message = `${level}: ${date}: ${plugin ? plugin + ': ' : ''}${args.join(', ')}`;
|
|
102
88
|
const formattedMessage = isExeption ? args.join(', ') : message;
|
|
@@ -121,4 +107,4 @@ exports.debugLogger = {
|
|
|
121
107
|
overrideConsoleMethods,
|
|
122
108
|
setExecutingPluginName,
|
|
123
109
|
};
|
|
124
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
110
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"debug-logger.js","sourceRoot":"","sources":["../../../src/common/util/debug-logger.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAErD,gDAA4C;AAE5C,MAAM,eAAe,GAA6B;IAChD,aAAa;IACb,YAAY;IACZ,kBAAkB;IAClB,qBAAqB;IACrB,oCAAoC;IACpC,6BAA6B;IAC7B,sBAAsB;IACtB,qBAAqB;IACrB,0BAA0B;IAC1B,6BAA6B;IAC7B,8BAA8B;IAC9B,YAAY;IACZ,WAAW;IACX,kCAAkC;IAClC,qBAAqB;IACrB,kBAAkB;IAClB,uBAAuB;IACvB,wBAAwB;CACzB,CAAC;AAEF,IAAK,QAKJ;AALD,WAAK,QAAQ;IACX,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;AACjB,CAAC,EALI,QAAQ,KAAR,QAAQ,QAKZ;AAED,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,OAAO,CAAC,GAAG;IAChB,IAAI,EAAE,OAAO,CAAC,IAAI;IAClB,IAAI,EAAE,OAAO,CAAC,IAAI;IAClB,KAAK,EAAE,OAAO,CAAC,KAAK;IACpB,KAAK,EAAE,OAAO,CAAC,KAAK;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,SAAkB,EAAE,EAAE;IACpD,OAAO,CAAC,GAAG,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3E,OAAO,CAAC,IAAI,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5E,OAAO,CAAC,IAAI,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5E,OAAO,CAAC,KAAK,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC9E,OAAO,CAAC,KAAK,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,UAAmB,EAAE,EAAE;IACrD,IAAA,oBAAU,GAAE,CAAC,iBAAiB,GAAG,UAAU,CAAC;AAC9C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,QAAQ,GAAG,CAAC,KAAe,EAAE,IAAW,EAAE,SAAkB,EAAE,EAAE;IACpE,IAAI,CAAC,SAAS,EAAE;QACd,IAAI,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE;YAC5B,OAAO;SACR;QAED,MAAM,UAAU,GACd,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ;YAC3B,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACzB,MAAM,OAAO,GACX,OAAO,gBAAO,CAAC,GAAG,CAAC,KAAK,UAAU;oBAChC,CAAC,CAAE,gBAAO,CAAC,GAAG,CAAc,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC3C,CAAC,CAAE,gBAAO,CAAC,GAAG,CAAY,CAAC;gBAE/B,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,UAAU,EAAE;YACf,eAAe,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;SAC9B;QAED,OAAO;KACR;IAED,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC9D,eAAe,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7B,OAAO;KACR;IAED,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;QACpB,eAAe,CAAC,GAAG,EAAE,CAAC;QACtB,OAAO;KACR;IAED,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,IAAA,oBAAU,GAAE,CAAC,iBAAiB,CAAC;IAC9C,MAAM,UAAU,GACd,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,GAAG,KAAK,KAAK,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAC3E,IAAI,CACL,EAAE,CAAC;IAEJ,MAAM,gBAAgB,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAEhE,IAAI,SAAS,EAAE;QACb,QAAQ,KAAK,EAAE;YACb,KAAK,QAAQ,CAAC,IAAI;gBAChB,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACvC,MAAM;YACR,KAAK,QAAQ,CAAC,IAAI;gBAChB,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACvC,MAAM;YACR,KAAK,QAAQ,CAAC,KAAK;gBACjB,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,QAAQ,CAAC,KAAK;gBACjB,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;gBACxC,MAAM;SACT;KACF;AACH,CAAC,CAAC;AAEW,QAAA,WAAW,GAAG;IACzB,sBAAsB;IACtB,sBAAsB;CACvB,CAAC","sourcesContent":["import {getStorage} from '../../common/util/storage';\n\nimport {STRINGS} from '../../if-run/config';\n\nconst logMessagesKeys: (keyof typeof STRINGS)[] = [\n  'STARTING_IF',\n  'EXITING_IF',\n  'LOADING_MANIFEST',\n  'VALIDATING_MANIFEST',\n  'CAPTURING_RUNTIME_ENVIRONMENT_DATA',\n  'CHECKING_AGGREGATION_METHOD',\n  'INITIALIZING_PLUGINS',\n  'INITIALIZING_PLUGIN',\n  'LOADING_PLUGIN_FROM_PATH',\n  'COMPUTING_PIPELINE_FOR_NODE',\n  'COMPUTING_COMPONENT_PIPELINE',\n  'REGROUPING',\n  'OBSERVING',\n  'MERGING_DEFAULTS_WITH_INPUT_DATA',\n  'AGGREGATING_OUTPUTS',\n  'AGGREGATING_NODE',\n  'PREPARING_OUTPUT_DATA',\n  'EXPORTING_TO_YAML_FILE',\n];\n\nenum LogLevel {\n  Info = 'INFO',\n  Warn = 'WARN',\n  Error = 'ERROR',\n  Debug = 'DEBUG',\n}\n\nconst originalConsole = {\n  log: console.log,\n  info: console.info,\n  warn: console.warn,\n  error: console.error,\n  debug: console.debug,\n};\n\n/**\n * Overrides console methods with custom debug logging.\n */\nconst overrideConsoleMethods = (debugMode: boolean) => {\n  console.log = (...args: any[]) => debugLog(LogLevel.Info, args, debugMode);\n  console.info = (...args: any[]) => debugLog(LogLevel.Info, args, debugMode);\n  console.warn = (...args: any[]) => debugLog(LogLevel.Warn, args, debugMode);\n  console.error = (...args: any[]) => debugLog(LogLevel.Error, args, debugMode);\n  console.debug = (...args: any[]) => debugLog(LogLevel.Debug, args, debugMode);\n};\n\n/**\n * Sets the name of the currently executing plugin.\n */\nconst setExecutingPluginName = (pluginName?: string) => {\n  getStorage().currentPluginName = pluginName;\n};\n\n/**\n * Logs messages with the specified log level and format.\n */\nconst debugLog = (level: LogLevel, args: any[], debugMode: boolean) => {\n  if (!debugMode) {\n    if (level === LogLevel.Debug) {\n      return;\n    }\n\n    const isDebugLog =\n      typeof args[0] === 'string' &&\n      logMessagesKeys.some(key => {\n        const message =\n          typeof STRINGS[key] === 'function'\n            ? (STRINGS[key] as Function).call(null, '')\n            : (STRINGS[key] as string);\n\n        return args[0].includes(message);\n      });\n\n    if (!isDebugLog) {\n      originalConsole.log(...args);\n    }\n\n    return;\n  }\n\n  if (typeof args[0] === 'string' && args[0].includes('# start')) {\n    originalConsole.log(...args);\n    return;\n  }\n\n  if (args[0] === '\\n') {\n    originalConsole.log();\n    return;\n  }\n\n  const date = new Date().toISOString();\n  const plugin = getStorage().currentPluginName;\n  const isExeption =\n    typeof args[0] === 'string' && args[0].includes('**Computing');\n  const message = `${level}: ${date}: ${plugin ? plugin + ': ' : ''}${args.join(\n    ', '\n  )}`;\n\n  const formattedMessage = isExeption ? args.join(', ') : message;\n\n  if (debugMode) {\n    switch (level) {\n      case LogLevel.Info:\n        originalConsole.info(formattedMessage);\n        break;\n      case LogLevel.Warn:\n        originalConsole.warn(formattedMessage);\n        break;\n      case LogLevel.Error:\n        originalConsole.error(formattedMessage);\n        break;\n      case LogLevel.Debug:\n        originalConsole.debug(formattedMessage);\n        break;\n    }\n  }\n};\n\nexport const debugLogger = {\n  overrideConsoleMethods,\n  setExecutingPluginName,\n};\n"]}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Get the storage for the current context
|
|
3
|
+
*/
|
|
4
|
+
export declare const getStorage: () => any;
|
|
5
|
+
/**
|
|
6
|
+
* Set up the context and execute the process
|
|
7
|
+
* @param callback The process to be executed after the context is set up
|
|
8
|
+
*/
|
|
9
|
+
export declare const executeWithContext: (callback: () => void) => void;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.executeWithContext = exports.getStorage = void 0;
|
|
4
|
+
const async_hooks_1 = require("async_hooks");
|
|
5
|
+
/**
|
|
6
|
+
* Create global storage
|
|
7
|
+
*/
|
|
8
|
+
const globalStorage = {};
|
|
9
|
+
/**
|
|
10
|
+
* Create async local storage
|
|
11
|
+
*/
|
|
12
|
+
const asyncLocalStorage = new async_hooks_1.AsyncLocalStorage();
|
|
13
|
+
/**
|
|
14
|
+
* Get the storage for the current context
|
|
15
|
+
*/
|
|
16
|
+
const getStorage = () => asyncLocalStorage.getStore() || globalStorage;
|
|
17
|
+
exports.getStorage = getStorage;
|
|
18
|
+
/**
|
|
19
|
+
* Set up the context and execute the process
|
|
20
|
+
* @param callback The process to be executed after the context is set up
|
|
21
|
+
*/
|
|
22
|
+
const executeWithContext = (callback) => asyncLocalStorage.run({}, callback);
|
|
23
|
+
exports.executeWithContext = executeWithContext;
|
|
24
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmFnZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21tb24vdXRpbC9zdG9yYWdlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZDQUE4QztBQUU5Qzs7R0FFRztBQUNILE1BQU0sYUFBYSxHQUFRLEVBQUUsQ0FBQztBQUU5Qjs7R0FFRztBQUNILE1BQU0saUJBQWlCLEdBQUcsSUFBSSwrQkFBaUIsRUFBRSxDQUFDO0FBRWxEOztHQUVHO0FBQ0ksTUFBTSxVQUFVLEdBQUcsR0FBRyxFQUFFLENBQUMsaUJBQWlCLENBQUMsUUFBUSxFQUFFLElBQUksYUFBYSxDQUFDO0FBQWpFLFFBQUEsVUFBVSxjQUF1RDtBQUU5RTs7O0dBR0c7QUFFSSxNQUFNLGtCQUFrQixHQUFHLENBQUMsUUFBb0IsRUFBUSxFQUFFLENBQy9ELGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxFQUFFLEVBQUUsUUFBUSxDQUFDLENBQUM7QUFEekIsUUFBQSxrQkFBa0Isc0JBQ08iLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge0FzeW5jTG9jYWxTdG9yYWdlfSBmcm9tICdhc3luY19ob29rcyc7XG5cbi8qKlxuICogQ3JlYXRlIGdsb2JhbCBzdG9yYWdlXG4gKi9cbmNvbnN0IGdsb2JhbFN0b3JhZ2U6IGFueSA9IHt9O1xuXG4vKipcbiAqIENyZWF0ZSBhc3luYyBsb2NhbCBzdG9yYWdlXG4gKi9cbmNvbnN0IGFzeW5jTG9jYWxTdG9yYWdlID0gbmV3IEFzeW5jTG9jYWxTdG9yYWdlKCk7XG5cbi8qKlxuICogR2V0IHRoZSBzdG9yYWdlIGZvciB0aGUgY3VycmVudCBjb250ZXh0XG4gKi9cbmV4cG9ydCBjb25zdCBnZXRTdG9yYWdlID0gKCkgPT4gYXN5bmNMb2NhbFN0b3JhZ2UuZ2V0U3RvcmUoKSB8fCBnbG9iYWxTdG9yYWdlO1xuXG4vKipcbiAqIFNldCB1cCB0aGUgY29udGV4dCBhbmQgZXhlY3V0ZSB0aGUgcHJvY2Vzc1xuICogQHBhcmFtIGNhbGxiYWNrIFRoZSBwcm9jZXNzIHRvIGJlIGV4ZWN1dGVkIGFmdGVyIHRoZSBjb250ZXh0IGlzIHNldCB1cFxuICovXG5cbmV4cG9ydCBjb25zdCBleGVjdXRlV2l0aENvbnRleHQgPSAoY2FsbGJhY2s6ICgpID0+IHZvaWQpOiB2b2lkID0+XG4gIGFzeW5jTG9jYWxTdG9yYWdlLnJ1bih7fSwgY2FsbGJhY2spO1xuIl19
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { ArgumentConfig, ParseOptions } from 'ts-command-line-args';
|
|
2
|
+
import type { IfApiArgs } from '../types/process-args';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for if-api.
|
|
5
|
+
*/
|
|
6
|
+
export declare const CONFIG: {
|
|
7
|
+
readonly ARGS: ArgumentConfig<IfApiArgs>;
|
|
8
|
+
readonly HELP: ParseOptions<IfApiArgs>;
|
|
9
|
+
};
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CONFIG = void 0;
|
|
4
|
+
const config_1 = require("../../common/config");
|
|
5
|
+
const { DISCLAIMER_MESSAGE } = config_1.STRINGS;
|
|
6
|
+
/**
|
|
7
|
+
* Configuration for if-api.
|
|
8
|
+
*/
|
|
9
|
+
exports.CONFIG = {
|
|
10
|
+
ARGS: {
|
|
11
|
+
debug: {
|
|
12
|
+
type: Boolean,
|
|
13
|
+
alias: 'd',
|
|
14
|
+
description: 'Print debug logs to the console',
|
|
15
|
+
defaultValue: false,
|
|
16
|
+
},
|
|
17
|
+
disableExternalPluginWarning: {
|
|
18
|
+
type: Boolean,
|
|
19
|
+
alias: 'w',
|
|
20
|
+
description: 'Disable external plugin warning',
|
|
21
|
+
defaultValue: false,
|
|
22
|
+
},
|
|
23
|
+
disabledPlugins: {
|
|
24
|
+
type: String,
|
|
25
|
+
alias: 'f',
|
|
26
|
+
description: 'Filename that contains plugin names to be disabled',
|
|
27
|
+
optional: true,
|
|
28
|
+
},
|
|
29
|
+
port: {
|
|
30
|
+
type: String,
|
|
31
|
+
alias: 'p',
|
|
32
|
+
description: 'Port to listen on',
|
|
33
|
+
defaultValue: process.env.PORT ?? '3000',
|
|
34
|
+
},
|
|
35
|
+
host: {
|
|
36
|
+
type: String,
|
|
37
|
+
alias: 'b',
|
|
38
|
+
description: 'Host to listen on',
|
|
39
|
+
defaultValue: process.env.HOST ?? 'localhost',
|
|
40
|
+
},
|
|
41
|
+
help: {
|
|
42
|
+
type: Boolean,
|
|
43
|
+
alias: 'h',
|
|
44
|
+
description: 'Show help',
|
|
45
|
+
optional: true,
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
HELP: {
|
|
49
|
+
helpArg: 'help',
|
|
50
|
+
headerContentSections: [
|
|
51
|
+
{ header: 'Impact Framework', content: 'Helpful keywords:' },
|
|
52
|
+
],
|
|
53
|
+
footerContentSections: [
|
|
54
|
+
{ header: 'Green Software Foundation', content: DISCLAIMER_MESSAGE },
|
|
55
|
+
],
|
|
56
|
+
},
|
|
57
|
+
};
|
|
58
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2lmLWFwaS9jb25maWcvY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBLGdEQUE0QztBQUk1QyxNQUFNLEVBQUMsa0JBQWtCLEVBQUMsR0FBRyxnQkFBTyxDQUFDO0FBRXJDOztHQUVHO0FBQ1UsUUFBQSxNQUFNLEdBQUc7SUFDcEIsSUFBSSxFQUFFO1FBQ0osS0FBSyxFQUFFO1lBQ0wsSUFBSSxFQUFFLE9BQU87WUFDYixLQUFLLEVBQUUsR0FBRztZQUNWLFdBQVcsRUFBRSxpQ0FBaUM7WUFDOUMsWUFBWSxFQUFFLEtBQUs7U0FDcEI7UUFDRCw0QkFBNEIsRUFBRTtZQUM1QixJQUFJLEVBQUUsT0FBTztZQUNiLEtBQUssRUFBRSxHQUFHO1lBQ1YsV0FBVyxFQUFFLGlDQUFpQztZQUM5QyxZQUFZLEVBQUUsS0FBSztTQUNwQjtRQUNELGVBQWUsRUFBRTtZQUNmLElBQUksRUFBRSxNQUFNO1lBQ1osS0FBSyxFQUFFLEdBQUc7WUFDVixXQUFXLEVBQUUsb0RBQW9EO1lBQ2pFLFFBQVEsRUFBRSxJQUFJO1NBQ2Y7UUFDRCxJQUFJLEVBQUU7WUFDSixJQUFJLEVBQUUsTUFBTTtZQUNaLEtBQUssRUFBRSxHQUFHO1lBQ1YsV0FBVyxFQUFFLG1CQUFtQjtZQUNoQyxZQUFZLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLElBQUksTUFBTTtTQUN6QztRQUNELElBQUksRUFBRTtZQUNKLElBQUksRUFBRSxNQUFNO1lBQ1osS0FBSyxFQUFFLEdBQUc7WUFDVixXQUFXLEVBQUUsbUJBQW1CO1lBQ2hDLFlBQVksRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksSUFBSSxXQUFXO1NBQzlDO1FBQ0QsSUFBSSxFQUFFO1lBQ0osSUFBSSxFQUFFLE9BQU87WUFDYixLQUFLLEVBQUUsR0FBRztZQUNWLFdBQVcsRUFBRSxXQUFXO1lBQ3hCLFFBQVEsRUFBRSxJQUFJO1NBQ2Y7S0FDMkI7SUFDOUIsSUFBSSxFQUFFO1FBQ0osT0FBTyxFQUFFLE1BQU07UUFDZixxQkFBcUIsRUFBRTtZQUNyQixFQUFDLE1BQU0sRUFBRSxrQkFBa0IsRUFBRSxPQUFPLEVBQUUsbUJBQW1CLEVBQUM7U0FDM0Q7UUFDRCxxQkFBcUIsRUFBRTtZQUNyQixFQUFDLE1BQU0sRUFBRSwyQkFBMkIsRUFBRSxPQUFPLEVBQUUsa0JBQWtCLEVBQUM7U0FDbkU7S0FDeUI7Q0FDcEIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHtBcmd1bWVudENvbmZpZywgUGFyc2VPcHRpb25zfSBmcm9tICd0cy1jb21tYW5kLWxpbmUtYXJncyc7XG5cbmltcG9ydCB7U1RSSU5HU30gZnJvbSAnLi4vLi4vY29tbW9uL2NvbmZpZyc7XG5cbmltcG9ydCB0eXBlIHtJZkFwaUFyZ3N9IGZyb20gJy4uL3R5cGVzL3Byb2Nlc3MtYXJncyc7XG5cbmNvbnN0IHtESVNDTEFJTUVSX01FU1NBR0V9ID0gU1RSSU5HUztcblxuLyoqXG4gKiBDb25maWd1cmF0aW9uIGZvciBpZi1hcGkuXG4gKi9cbmV4cG9ydCBjb25zdCBDT05GSUcgPSB7XG4gIEFSR1M6IHtcbiAgICBkZWJ1Zzoge1xuICAgICAgdHlwZTogQm9vbGVhbixcbiAgICAgIGFsaWFzOiAnZCcsXG4gICAgICBkZXNjcmlwdGlvbjogJ1ByaW50IGRlYnVnIGxvZ3MgdG8gdGhlIGNvbnNvbGUnLFxuICAgICAgZGVmYXVsdFZhbHVlOiBmYWxzZSxcbiAgICB9LFxuICAgIGRpc2FibGVFeHRlcm5hbFBsdWdpbldhcm5pbmc6IHtcbiAgICAgIHR5cGU6IEJvb2xlYW4sXG4gICAgICBhbGlhczogJ3cnLFxuICAgICAgZGVzY3JpcHRpb246ICdEaXNhYmxlIGV4dGVybmFsIHBsdWdpbiB3YXJuaW5nJyxcbiAgICAgIGRlZmF1bHRWYWx1ZTogZmFsc2UsXG4gICAgfSxcbiAgICBkaXNhYmxlZFBsdWdpbnM6IHtcbiAgICAgIHR5cGU6IFN0cmluZyxcbiAgICAgIGFsaWFzOiAnZicsXG4gICAgICBkZXNjcmlwdGlvbjogJ0ZpbGVuYW1lIHRoYXQgY29udGFpbnMgcGx1Z2luIG5hbWVzIHRvIGJlIGRpc2FibGVkJyxcbiAgICAgIG9wdGlvbmFsOiB0cnVlLFxuICAgIH0sXG4gICAgcG9ydDoge1xuICAgICAgdHlwZTogU3RyaW5nLFxuICAgICAgYWxpYXM6ICdwJyxcbiAgICAgIGRlc2NyaXB0aW9uOiAnUG9ydCB0byBsaXN0ZW4gb24nLFxuICAgICAgZGVmYXVsdFZhbHVlOiBwcm9jZXNzLmVudi5QT1JUID8/ICczMDAwJyxcbiAgICB9LFxuICAgIGhvc3Q6IHtcbiAgICAgIHR5cGU6IFN0cmluZyxcbiAgICAgIGFsaWFzOiAnYicsXG4gICAgICBkZXNjcmlwdGlvbjogJ0hvc3QgdG8gbGlzdGVuIG9uJyxcbiAgICAgIGRlZmF1bHRWYWx1ZTogcHJvY2Vzcy5lbnYuSE9TVCA/PyAnbG9jYWxob3N0JyxcbiAgICB9LFxuICAgIGhlbHA6IHtcbiAgICAgIHR5cGU6IEJvb2xlYW4sXG4gICAgICBhbGlhczogJ2gnLFxuICAgICAgZGVzY3JpcHRpb246ICdTaG93IGhlbHAnLFxuICAgICAgb3B0aW9uYWw6IHRydWUsXG4gICAgfSxcbiAgfSBhcyBBcmd1bWVudENvbmZpZzxJZkFwaUFyZ3M+LFxuICBIRUxQOiB7XG4gICAgaGVscEFyZzogJ2hlbHAnLFxuICAgIGhlYWRlckNvbnRlbnRTZWN0aW9uczogW1xuICAgICAge2hlYWRlcjogJ0ltcGFjdCBGcmFtZXdvcmsnLCBjb250ZW50OiAnSGVscGZ1bCBrZXl3b3JkczonfSxcbiAgICBdLFxuICAgIGZvb3RlckNvbnRlbnRTZWN0aW9uczogW1xuICAgICAge2hlYWRlcjogJ0dyZWVuIFNvZnR3YXJlIEZvdW5kYXRpb24nLCBjb250ZW50OiBESVNDTEFJTUVSX01FU1NBR0V9LFxuICAgIF0sXG4gIH0gYXMgUGFyc2VPcHRpb25zPElmQXBpQXJncz4sXG59IGFzIGNvbnN0O1xuIl19
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.STRINGS = exports.CONFIG = void 0;
|
|
4
|
+
var config_1 = require("./config");
|
|
5
|
+
Object.defineProperty(exports, "CONFIG", { enumerable: true, get: function () { return config_1.CONFIG; } });
|
|
6
|
+
var strings_1 = require("./strings");
|
|
7
|
+
Object.defineProperty(exports, "STRINGS", { enumerable: true, get: function () { return strings_1.STRINGS; } });
|
|
8
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvaWYtYXBpL2NvbmZpZy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxtQ0FBZ0M7QUFBeEIsZ0dBQUEsTUFBTSxPQUFBO0FBQ2QscUNBQWtDO0FBQTFCLGtHQUFBLE9BQU8sT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7Q09ORklHfSBmcm9tICcuL2NvbmZpZyc7XG5leHBvcnQge1NUUklOR1N9IGZyb20gJy4vc3RyaW5ncyc7XG4iXX0=
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Strings for if-api.
|
|
3
|
+
*/
|
|
4
|
+
export declare const STRINGS: {
|
|
5
|
+
readonly SERVER_STARTED: (addr: string) => string;
|
|
6
|
+
readonly SERVER_START_FAILED: (err: Error) => string;
|
|
7
|
+
readonly PROCESSING_REQUEST: "Processing request";
|
|
8
|
+
readonly INTERNAL_SERVER_ERROR: "Internal Server Error";
|
|
9
|
+
readonly INVALID_JSON: "Invalid JSON format";
|
|
10
|
+
readonly INVALID_YAML: "Invalid YAML format";
|
|
11
|
+
readonly MISSING_MANIFEST: "Missing manifest in request body";
|
|
12
|
+
readonly UNSUPPORTED_CONTENT_TYPE: "Unsupported content type. Supported types are: application/json, application/yaml";
|
|
13
|
+
readonly DISCLAIMER_MESSAGE: "Impact Framework API - Green Software Foundation";
|
|
14
|
+
readonly INVALID_DISABLED_PLUGINS: (line: string) => string;
|
|
15
|
+
readonly INVALID_PORT_NUMBER: (port: string) => string;
|
|
16
|
+
};
|