Skip to content

Commit ad7793e

Browse files
authored
chore(orchestrator): rename http-test-server to http-workflow-dev-server (#741)
Signed-off-by: Marek Libra <marek.libra@gmail.com>
1 parent 89ee64d commit ad7793e

9 files changed

Lines changed: 12 additions & 12 deletions

File tree

workspaces/orchestrator/plugins/orchestrator-form-widgets/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ Example of response:
6969
}
7070
```
7171

72-
## HTTP Test Server
72+
## HTTP server for dynamic widgets development - http-workflow-dev-server
7373

74-
**For the development purposes only**, there is `http-test-server`, very simple Express Node.js server which responds with JSON schema chunks for the `SchemaUpdater` and other active widgets.
74+
**For the development purposes only**, there is `http-workflow-dev-server`, very simple Express Node.js server which responds with JSON schema chunks for the `SchemaUpdater` and other active widgets.
7575

7676
Moreover, it does extensive logging of the received HTTP requests for debugging during the widget's development.
7777

78-
Refer to [http-test-server](./http-test-server/README.md) for more details.
78+
Refer to [http-workflow-dev-server](./http-workflow-dev-server/README.md) for more details.
7979

8080
## How to develop widgets
8181

@@ -86,7 +86,7 @@ This instance is already configured to statically load the widget library (see `
8686

8787
To develop the widgets, we recommend to uncomment or further configure the `integrations:` and `auth:` sections in the `./workspaces/orchestrator/app-config.yaml` to be able to test various SCM Auth providers within `$${{}}` templates.
8888

89-
Please note, that the `proxy:` section is already pre-configured to match the `http-test-server` listening on localhost.
89+
Please note, that the `proxy:` section is already pre-configured to match the `http-workflow-dev-server` listening on localhost.
9090

9191
Make sure your user has an entity in the Catalog and the authentication is otherwise configured so the tokens and user's profile info can be fetched by the workflow and `$${{identityApi.[various_keys]}}` templating.
9292

@@ -98,7 +98,7 @@ yarn install
9898
```
9999

100100
```bash
101-
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server
101+
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server
102102
yarn update-running-workflow # which will copy the workflow under Backstage backend cache
103103
```
104104

@@ -134,21 +134,21 @@ yarn start
134134
- In third terminal, run the HTTP test server:
135135

136136
```bash
137-
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server
137+
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server
138138

139139
yarn install
140140
yarn start
141141
```
142142

143143
### The dynamic_schema workflow
144144

145-
There is `dynamic_schema` workflow located under `http-test-server/exampleWorkflows`.
145+
There is `dynamic_schema` workflow located under `http-workflow-dev-server/exampleWorkflows`.
146146
Its purpose is to have a playground when developing the widgets.
147147

148-
The URLs referenced from this workflow's data input schema rely on proxy configured in the `./workspaces/orchestrator/app-config.yaml` which assumes the `http-test-server` to be running.
148+
The URLs referenced from this workflow's data input schema rely on proxy configured in the `./workspaces/orchestrator/app-config.yaml` which assumes the `http-workflow-dev-server` to be running.
149149

150150
This dev-only workflow is similar to https://github.com/rhdhorchestrator/backstage-orchestrator-workflows/blob/main/workflows/dynamic.schema.sw.json .
151-
The difference is in the URLs used - the backstage-orchestrator-workflows' one references public GitHub HTTP server, so no extra steps in running the `http-test-server` are needed.
151+
The difference is in the URLs used - the backstage-orchestrator-workflows' one references public GitHub HTTP server, so no extra steps in running the `http-workflow-dev-server` are needed.
152152

153153
## Development of a workflow using orchestrator-form-widgets
154154

Binary file not shown.

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/README.md renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/README.md

File renamed without changes.

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/exampleWorkflows/dynamic.schema.sw.json renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/exampleWorkflows/dynamic.schema.sw.json

File renamed without changes.

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/exampleWorkflows/schemas/dynamic_schema__main-schema.json renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/exampleWorkflows/schemas/dynamic_schema__main-schema.json

File renamed without changes.

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/index.js renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/index.js

File renamed without changes.

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/package.json renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "http-test-server",
2+
"name": "http-workflow-dev-server",
33
"version": "5.2.3",
44
"license": "Apache-2.0",
55
"main": "index.ts",

workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server/yarn.lock renamed to workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/yarn.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,9 @@ __metadata:
304304
languageName: node
305305
linkType: hard
306306

307-
"http-test-server@workspace:.":
307+
"http-workflow-dev-server@workspace:.":
308308
version: 0.0.0-use.local
309-
resolution: "http-test-server@workspace:."
309+
resolution: "http-workflow-dev-server@workspace:."
310310
dependencies:
311311
express: ^5.1.0
312312
prettier: 3.4.2

0 commit comments

Comments
 (0)