bryopsida/syslog-api

API to query data recorded to mongodb by syslog-portal

Syslog-Api

Archived

Archiving for now as CouchDB's API + CURL & JQ suit my needs for looking through the data.

Description

A api for fetching and querying recorded messages from the syslog-api

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

syslog-api's Issues

Useful Readme (API)

Current readme is a placeholder/boilerplate, README should be updated with information for the following:

• How to build
• How to debug
• How to contribute
• How to configure
• How to deploy
• Links to associated repos with other component parts of the solution

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency ts-jest to v29.1.5
• fix(deps): update dependency argon2 to v0.40.3
• chore(deps): update dependency @types/node to v20.14.9
• chore(deps): update dependency testcontainers to v10.10.0
• chore(deps): update dependency typescript to v5.5.2
• chore(deps): update typescript-eslint monorepo to v7.14.1 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency graphql to v16.9.0
• fix(deps): update dependency mongoose to v8.4.4
• fix(deps): update dependency nestjs-pino to v4.1.0
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency fastify to v4.28.0
• fix(deps): update dependency passport to ^0.7.0
• fix(deps): update dependency reflect-metadata to ^0.2.0
• chore(deps): update dependency eslint to v9
• chore(deps): update dependency eslint-plugin-prettier to v5
• chore(deps): update dependency prettier to v3
• fix(deps): update dependency @nestjs/graphql to v12
• fix(deps): update dependency @nestjs/mercurius to v12
• fix(deps): update dependency pino-http to v10
• fix(deps): update nest monorepo to v10 (major) (@nestjs/common, @nestjs/core, @nestjs/passport, @nestjs/platform-fastify, @nestjs/schematics, @nestjs/terminus, @nestjs/testing)
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency mercurius to v11 [security]

Detected dependencies

dockerfile

Dockerfile

github-actions

.github/workflows/ci.yaml

npm

package.json

• @fastify/helmet ^11.0.0
• @nestjs/common ^9.0.0
• @nestjs/config ^3.0.0
• @nestjs/core ^9.0.0
• @nestjs/graphql ^10.1.7
• @nestjs/jwt ^10.0.1
• @nestjs/mercurius ^10.1.7
• @nestjs/mongoose ^10.0.0
• @nestjs/passport ^9.0.0
• @nestjs/platform-fastify ^9.2.1
• @nestjs/terminus ^9.2.2
• argon2 ^0.40.0
• class-validator ^0.14.0
• fastify ^4.12.0
• graphql ^16.6.0
• mercurius ^10.5.1
• mongoose ^8.0.0
• nestjs-pino ^4.0.0
• passport ^0.6.0
• passport-jwt ^4.0.1
• passport-local ^1.0.0
• pino-http ^9.0.0
• reflect-metadata ^0.1.13
• rxjs ^7.2.0
• @nestjs/cli ^10.0.0
• @nestjs/schematics ^9.0.0
• @nestjs/testing ^9.0.0
• @types/jest 29.5.12
• @types/node 20.12.11
• @types/passport-jwt ^4.0.0
• @types/passport-local ^1.0.35
• @types/supertest ^6.0.0
• @typescript-eslint/eslint-plugin ^7.0.0
• @typescript-eslint/parser ^7.0.0
• eslint ^8.0.1
• eslint-config-prettier ^9.0.0
• eslint-plugin-prettier ^4.0.0
• jest 29.7.0
• prettier ^2.3.2
• source-map-support ^0.5.20
• supertest ^7.0.0
• testcontainers ^10.0.0
• ts-jest 29.1.2
• ts-loader ^9.2.3
• ts-node ^10.0.0
• tsconfig-paths 4.2.0
• typescript ^5.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Userservice account store uses mongodb (API)

As a maintainer I want the API to use a data store such as mongodb for accounts instead of hardcoded dummy accounts.

AC:

• Can seed/manage accounts on startup in a way that's compatible with the twelve factor app and is secure
• Password credentials are hashed after seed (argon password hash)
• Credential information is not held onto after startup (don't hold copies in memory)
• Accounts are stored in mongodb collection
• User service validates credentials against stored credentials in mongodb collection

Typedocs (API)

Reasonable Logging (API)

Subscriptions (API)

As a API consumer I want to have the capability to subscribe to data streams and receive updates when new items that match my criteria have been added.

Authentication (API)

As a maintainer I need to be able to restrict access to authorized users, to start with an option for http basic/digest will be sufficient.

Add workflow running E2E (Tests)

Add tests that run all of the components with the new proposed piece in PR for verification of integration and functionality. E2E tests are defined in the syslog-e2e-tests repo, this should take the latest main revision of the portal and ui, inject log data into the stream, and verify the data is available on the API and UI. The api revision should be the revision built in the PR.

Purpose of this is to ensure that new change increments are compatible with all the pieces before merge to main.

Configurable JWT secret (API)

As a maintainer I would like to be able to configure the JWT secret in a secure manner.

Configurable Mongoose Conn Str (API)

As a maintainer I need to be able to configure values for the hostname and credentials for the mongodb instance used by mongoose.