feat(web): add DEFAULT_CONTAINER_LOG_TAIL to .env (#915)

web/crux-ui/locales/en/common.json

@@ -24,6 +24,7 @@
   "copy": "Copy",
   "copied": "Copied.",
   "delete": "Delete",
+  "log": "Log",
 
   "home": "Home",
   "settings": "Settings",

web/crux/.env.example

@@ -1,6 +1,6 @@
 NODE_ENV=development
 
-## Development configurations
+# # Development configurations
 
 # Kratos public API
 KRATOS_URL=http://localhost:8000/kratos
@@ -10,7 +10,7 @@ KRATOS_ADMIN_URL=http://localhost:4434
 DATABASE_URL="postgresql://username:password@localhost:5432/crux?schema=public"
 CRUX_UI_URL=http://localhost:8000
 
-## Port settings
+# # Port settings
 
 # Agent gRPC API port
 GRPC_AGENT_PORT=5000
@@ -45,19 +45,22 @@ ENCRYPTION_SECRET_KEY=
 # Example: error contains fatal
 LOG_LEVEL=debug
 
-## Email service config
+# # Email service config
 # SMTP URL for the mailslurper
 SMTP_URI=smtps://test:test@localhost:1025/?skip_ssl_verify=true&legacy_ssl=true
 # E-mail address for dyrector.io invitation links, password resets and others
 FROM_EMAIL=from@example.com
 # E-mail sender name for dyrector.io invitation links, password resets and others
 FROM_NAME=dyrector.io
 
-## Google ReCAPTCHA config
+# Google ReCAPTCHA config
 DISABLE_RECAPTCHA=true
 # Required only when ReCAPTCHA is enabled
 RECAPTCHA_SECRET_KEY=<recaptcha_secret_key>
 
+# Determines the quantity of lines being returned by a Docker container, while streaming its logs
+DEFAULT_CONTAINER_LOG_TAIL=100
+
 # For overriding the node DNS result order
 # regardless of the NODE_ENV value
 # It may be necessary for running the e2e tests,

web/crux/src/app/node/node.service.spec.ts

@@ -1,3 +1,4 @@
+import { ConfigService } from '@nestjs/config'
 import { Test, TestingModule } from '@nestjs/testing'
 import { of } from 'rxjs'
 import DomainNotificationService from 'src/services/domain.notification.service'
@@ -43,6 +44,10 @@ describe('NodeService', () => {
             provide: PrismaService,
             useValue: jest.mocked(PrismaService),
           },
+          {
+            provide: ConfigService,
+            useValue: jest.mocked(ConfigService),
+          },
           NodeService,
         ],
       }).compile()

web/crux/src/app/node/node.service.ts

@@ -1,4 +1,5 @@
 import { Injectable, Logger } from '@nestjs/common'
+import { ConfigService } from '@nestjs/config'
 import { Identity } from '@ory/kratos-client'
 import { Prisma } from '@prisma/client'
 import {
@@ -57,6 +58,7 @@ export default class NodeService {
     private readonly agentService: AgentService,
     private readonly mapper: NodeMapper,
     private readonly notificationService: DomainNotificationService,
+    private readonly configService: ConfigService,
   ) {}
 
   async checkNodeIsInTheTeam(teamSlug: string, nodeId: string, identity: Identity): Promise<boolean> {
@@ -247,7 +249,10 @@ export default class NodeService {
 
     const agent = this.agentService.getByIdOrThrow(nodeId)
 
-    const stream = agent.upsertContainerLogStream(container)
+    const stream = agent.upsertContainerLogStream(
+      container,
+      this.configService.get<number>('DEFAULT_CONTAINER_LOG_TAIL', 1000),
+    )
 
     return stream.watch()
   }

web/crux/src/config/app.config.ts

@@ -42,6 +42,8 @@ const configSchema = yup.object({
 
   QA_OPT_OUT: yup.bool().default(false).required(),
   QA_GROUP_NAME: yup.string().optional(),
+
+  DEFAULT_CONTAINER_LOG_TAIL: yup.number().optional(),
 })
 
 class InvalidEnvironmentError extends Error {

web/crux/src/domain/agent.spec.ts

@@ -11,7 +11,7 @@ import {
   DeploymentStatusMessage,
   Empty,
 } from 'src/grpc/protobuf/proto/common'
-import { DEFAULT_CONTAINER_LOG_TAIL, GET_CONTAINER_SECRETS_TIMEOUT_MILLIS } from 'src/shared/const'
+import { GET_CONTAINER_SECRETS_TIMEOUT_MILLIS } from 'src/shared/const'
 import GrpcNodeConnection from 'src/shared/grpc-node-connection'
 import { Agent, AgentConnectionMessage } from './agent'
 import { generateAgentToken } from './agent-token'
@@ -341,7 +341,8 @@ describe('agent', () => {
       name: 'name',
     }
 
-    const logStream = agent.upsertContainerLogStream(container)
+    const tail = 1000
+    const logStream = agent.upsertContainerLogStream(container, tail)
 
     const logEvent = firstValueFrom(logStream.watch().pipe(skip(1)))
 
@@ -353,7 +354,7 @@ describe('agent', () => {
           name: 'name',
         },
         streaming: true,
-        tail: DEFAULT_CONTAINER_LOG_TAIL,
+        tail,
       },
     })
 

web/crux/src/domain/agent.ts

@@ -1,6 +1,6 @@
 import { Logger } from '@nestjs/common'
 import { DeploymentStatusEnum } from '@prisma/client'
-import { catchError, finalize, Observable, of, Subject, Subscription, throwError, timeout, TimeoutError } from 'rxjs'
+import { Observable, Subject, Subscription, TimeoutError, catchError, finalize, of, throwError, timeout } from 'rxjs'
 import { NodeConnectionStatus } from 'src/app/node/node.dto'
 import {
   CruxConflictException,
@@ -19,7 +19,6 @@ import {
 } from 'src/grpc/protobuf/proto/common'
 import {
   CONTAINER_DELETE_TIMEOUT_MILLIS,
-  DEFAULT_CONTAINER_LOG_TAIL,
   GET_CONTAINER_INSPECTION_TIMEOUT_MILLIS,
   GET_CONTAINER_SECRETS_TIMEOUT_MILLIS,
 } from 'src/shared/const'
@@ -165,13 +164,13 @@ export class Agent {
     return watcher
   }
 
-  upsertContainerLogStream(container: ContainerIdentifier): ContainerLogStream {
+  upsertContainerLogStream(container: ContainerIdentifier, tail: number): ContainerLogStream {
     this.throwIfCommandsAreDisabled()
 
     const key = Agent.containerPrefixNameOf(container)
     let stream = this.logStreams.get(key)
     if (!stream) {
-      stream = new ContainerLogStream(container, DEFAULT_CONTAINER_LOG_TAIL)
+      stream = new ContainerLogStream(container, tail)
       this.logStreams.set(key, stream)
       stream.start(this.commandChannel)
     }

web/crux/src/domain/container-log-stream.ts

@@ -14,8 +14,8 @@ export default class ContainerLogStream {
   private completer: ContainerLogStreamCompleter = null
 
   constructor(
-    private container: ContainerIdentifier,
-    private tail: number,
+    private readonly container: ContainerIdentifier,
+    private readonly tail: number,
   ) {}
 
   start(commandChannel: Subject<AgentCommand>) {

web/crux/src/shared/const.ts

@@ -18,8 +18,6 @@ export const CONTAINER_DELETE_TIMEOUT_MILLIS = 1000
 export const GET_CONTAINER_SECRETS_TIMEOUT_MILLIS = 5000
 export const GET_CONTAINER_INSPECTION_TIMEOUT_MILLIS = 5000
 
-export const DEFAULT_CONTAINER_LOG_TAIL = 40
-
 // NOTE(@m8vago): This should be incremented, when a new release includes a proto file change
 const AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION = '0.11.0'
 export const AGENT_SUPPORTED_MINIMUM_VERSION = coerce(AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION)