Skip to content

Commit 9c2ddd0

Browse files
Merge pull request #759 from reactome/deltasignal-on-beta-docs-2
DeltaSignal on beta, from #757's review: docs
2 parents 3b379cf + d3b28e9 commit 9c2ddd0

3 files changed

Lines changed: 18 additions & 12 deletions

File tree

‎deploy/nginx/README.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,15 @@ The shared routes name `site`, `content`, `analysis`, `content_node`,
9090
absorbs both: node in this repository taking over most of what Tomcat serves, and
9191
the site being startable locally, where they become compose service names.
9292

93-
`/api/` for DeltaSignal exists in none of the Apache configuration, which is why
94-
DeltaSignal cannot work on beta today — the Angular side calls it as a bare
95-
relative path, routed only by the dev server's proxy, which does not exist in a
96-
built artifact. Note the port on the dev box: **8090**, not the 8080 DeltaSignal's
97-
own compose binds, because 8080 there is Tomcat.
93+
`/api/` is DeltaSignal's: the Angular side calls `/api/pathways`, `/api/parse` and
94+
`/api/solve` as bare relative paths, which `common/routes.conf` sends to the
95+
`deltasignal` upstream (the dev server's proxy does the same under `ng serve`).
96+
Beta's site profile turns the Perturb button on because of this route; only a
97+
deployment with this route may turn `deltaSignal` on. The DeltaSignal service is not part of
98+
this repository's compose: it runs from DeltaSignal's own repository on the same
99+
host, published on loopback only, at **8090**, not the 8080 DeltaSignal's own
100+
compose binds, because 8080 there is Tomcat. If it stops, the button's calls fail;
101+
`/api/pathways` answering a list confirms it is up.
98102

99103
## Connections, which is a reason this is worth doing
100104

‎e2e/deltasignal-toggle.spec.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/**
22
* DeltaSignal is offered only where a deployment asks for it.
33
*
4-
* It is a research feature that depends on a DeltaSignal backend, and `/api` is
5-
* routed only by proxy.conf.js -- the dev server's proxy, which does not exist in
6-
* a built artifact. A deployment without that backend must not offer a button
7-
* whose every call fails, so the profile decides, and absent means off.
4+
* It is a research feature that depends on a DeltaSignal backend, reached at
5+
* `/api` through proxy.conf.js under the dev server and through nginx on beta. A
6+
* deployment without that route must not offer a button whose every call fails,
7+
* so the profile decides, and absent means off.
88
*
99
* Both states are checked against one build by setting `window.__APP_ENV` before
1010
* the app's scripts run, which is the runtime profile override the config already
@@ -54,6 +54,8 @@ test.describe('The DeltaSignal toggle', () => {
5454
await expect(page.locator('cr-deltasignal-panel')).toHaveCount(0);
5555
});
5656

57+
// One "on" case: its title keys its recorded backend, and which profiles have
58+
// the flag (development and beta) is pinned by environments.spec.ts.
5759
test('offers it on a deployment that does', async ({ page }) => {
5860
await openWithProfile(page, 'development');
5961
await expect(perturb(page)).toHaveCount(1);

‎projects/website-angular/src/config/environments.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ export interface SiteProfile {
5252
* `specs/005-search-page-answers/research.md`, D1 and D3.
5353
*
5454
* Absent means off, like `deltaSignal`, so a deployment opts in rather than
55-
* inherits. Only `development` has it today: the endpoint is not deployed on
56-
* beta yet, and no keypair has been exchanged, so every other profile would
57-
* offer a button whose calls fail.
55+
* inherits. `development` and `beta` have it: beta's route is served by
56+
* serve-prod.js, which holds the signing key (see the beta profile); any other
57+
* profile would offer a button whose calls fail.
5858
*/
5959
searchAnswerEndpoint?: string;
6060
/**

0 commit comments

Comments
 (0)