From e898d2e5e03a4b843cd5bd48cd0c991ab01d2c83 Mon Sep 17 00:00:00 2001
From: Steve Reis <stevereis93@gmail.com>
Date: Wed, 20 Jul 2022 11:10:37 +0200
Subject: [PATCH] docs: Update code for documentation
---
api/.env.defaults | 5 +++++
api/src/engine/connectors/exareme/exareme.connector.ts | 1 -
api/src/engine/engine.constants.ts | 1 +
api/src/engine/engine.resolver.ts | 4 +++-
.../engine/interfaces/connector-configuration.interface.ts | 5 +----
api/src/engine/models/configuration.model.ts | 6 +++++-
api/src/schema.gql | 2 +-
7 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/api/.env.defaults b/api/.env.defaults
index eda459d..c6b1dbd 100644
--- a/api/.env.defaults
+++ b/api/.env.defaults
@@ -14,3 +14,8 @@ AUTH_JWT_SECRET=SecretForDevPurposeOnly
AUTH_JWT_TOKEN_EXPIRES_IN=2d
AUTH_COOKIE_SAME_SITE=strict
AUTH_COOKIE_SECURE=true
+
+# Cache
+CACHE_ENABLED=true
+CACHE_TTL=1800 # 1800 == 30 minutes
+CACHE_MAX_ITEMS=100
\ No newline at end of file
diff --git a/api/src/engine/connectors/exareme/exareme.connector.ts b/api/src/engine/connectors/exareme/exareme.connector.ts
index c628a36..8fd464d 100644
--- a/api/src/engine/connectors/exareme/exareme.connector.ts
+++ b/api/src/engine/connectors/exareme/exareme.connector.ts
@@ -66,7 +66,6 @@ export default class ExaremeConnector implements Connector {
getConfiguration(): ConnectorConfiguration {
return {
- contactLink: 'https://ebrains.eu/support/',
hasGalaxy: true,
hasGrouping: true,
};
diff --git a/api/src/engine/engine.constants.ts b/api/src/engine/engine.constants.ts
index 351c3aa..52fc05a 100644
--- a/api/src/engine/engine.constants.ts
+++ b/api/src/engine/engine.constants.ts
@@ -1,3 +1,4 @@
export const ENGINE_MODULE_OPTIONS = 'EngineModuleOption';
export const ENGINE_SKIP_TOS = 'TOS_SKIP';
export const ENGINE_ONTOLOGY_URL = 'ONTOLOGY_URL';
+export const ENGINE_CONTACT_LINK = 'CONTACT_LINK';
diff --git a/api/src/engine/engine.resolver.ts b/api/src/engine/engine.resolver.ts
index 69718a7..cb0ffac 100644
--- a/api/src/engine/engine.resolver.ts
+++ b/api/src/engine/engine.resolver.ts
@@ -1,6 +1,6 @@
import { Inject, UseGuards, UseInterceptors } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
-import { Args, Query, Resolver } from '@nestjs/graphql';
+import { Query, Resolver } from '@nestjs/graphql';
import { Request } from 'express';
import { Public } from 'src/auth/decorators/public.decorator';
import { GlobalAuthGuard } from 'src/auth/guards/global-auth.guard';
@@ -9,6 +9,7 @@ import { Md5 } from 'ts-md5';
import { authConstants } from '../auth/auth-constants';
import { GQLRequest } from '../common/decorators/gql-request.decoractor';
import {
+ ENGINE_CONTACT_LINK,
ENGINE_MODULE_OPTIONS,
ENGINE_ONTOLOGY_URL,
ENGINE_SKIP_TOS,
@@ -52,6 +53,7 @@ export class EngineResolver {
),
matomo,
ontologyUrl: this.configSerivce.get(ENGINE_ONTOLOGY_URL),
+ contactLink: this.configSerivce.get(ENGINE_CONTACT_LINK),
};
const version = Md5.hashStr(JSON.stringify(data));
diff --git a/api/src/engine/interfaces/connector-configuration.interface.ts b/api/src/engine/interfaces/connector-configuration.interface.ts
index d327ded..240e98e 100644
--- a/api/src/engine/interfaces/connector-configuration.interface.ts
+++ b/api/src/engine/interfaces/connector-configuration.interface.ts
@@ -1,8 +1,5 @@
import { Configuration } from '../models/configuration.model';
-type ConnectorConfiguration = Pick<
- Configuration,
- 'contactLink' | 'hasGalaxy' | 'hasGrouping'
->;
+type ConnectorConfiguration = Pick<Configuration, 'hasGalaxy' | 'hasGrouping'>;
export default ConnectorConfiguration;
diff --git a/api/src/engine/models/configuration.model.ts b/api/src/engine/models/configuration.model.ts
index a7aeea0..854f5c5 100644
--- a/api/src/engine/models/configuration.model.ts
+++ b/api/src/engine/models/configuration.model.ts
@@ -5,7 +5,11 @@ export class Configuration {
@Field()
connectorId: string;
- @Field({ nullable: true, defaultValue: false })
+ @Field({
+ nullable: true,
+ defaultValue: false,
+ deprecationReason: 'Only used for legacy reason should be avoided',
+ })
hasGalaxy?: boolean;
@Field({
diff --git a/api/src/schema.gql b/api/src/schema.gql
index 9caebad..4177333 100644
--- a/api/src/schema.gql
+++ b/api/src/schema.gql
@@ -33,7 +33,7 @@ type Matomo {
type Configuration {
connectorId: String!
- hasGalaxy: Boolean
+ hasGalaxy: Boolean @deprecated(reason: "Only used for legacy reason should be avoided")
"""Indicates if histograms can handle grouping"""
hasGrouping: Boolean
--
GitLab