beavuck-time 2.3.5 → 2.3.7

package/.gitlab/issue_templates/bug.md

@@ -1,53 +0,0 @@
-## 🗒️ Summary
-
-(_Summarize the bug encountered concisely. "X happens"_)
-
----
-
-## 🐛 What is the current bug behavior?
-
-(_What actually happens. "When W, then X"_)
-
----
-
-## 🟢 What is the expected correct behavior?
-
-(_What you should see instead. "When W, then 42"_)
-
----
-
-## 📋 Steps to reproduce
-
-(_How one can reproduce the issue - this is very important. Please use a numbered list_)
-
-1. Step 1
-2. Step 2
-3. Step 3
-
-...
-
----
-
-## 📜 Relevant logs and/or screenshots
-
-(_Paste any relevant logs - please use code blocks (```) to format console output, logs, etc. as it's very hard to read otherwise._)
-
-(_for example_:
-
-```
-Error: something went wrong
-```
-
-)
-
----
-
-## ⛳ Possible fixes
-
-(_Optional: If you have an idea of how to fix this, link to the code or describe the solution_)
-
----
-
-(_Automatically adds the bug label for easier tracking_)
-
-/label ~bug

package/.gitlab/issue_templates/enhancement.md

@@ -1,53 +0,0 @@
-## 🗒️ Summary
-
-(_Summarize the enhancement you'd like to see implemented concisely. "Add X functionality"_)
-
----
-
-## 🔍 What problem does this enhancement solve?
-
-(_Describe the problem this enhancement would address. "Currently, Y is a limitation, and adding X would solve it"_)
-
----
-
-## 🎯 What is the proposed solution?
-
-(_Describe how you envision this enhancement being implemented. "Add a new method for Z"_)
-
----
-
-## 🚀 Why is this enhancement valuable to the product?
-
-(_Explain why this enhancement would improve the product. "This would make the process faster, reduce errors, etc."_)
-
----
-
-## 📋 Steps to use the feature (if the enhancement is indeed a feature)
-
-(_How will users interact with this feature? Describe the user journey or interface interactions.
-For bonus points, use a user story format, and add a
-[sequence diagram](https://mermaid.js.org/syntax/sequenceDiagram.html) or [flowchart](https://mermaid.js.org/syntax/flowchart.html)_)
-
-(_For example_:
-
-```mermaid
-sequenceDiagram
-    participant Client
-    participant API
-    Client->>API: GET /now (ask for time)
-    API->>Client: {"now": "2024-06-14T18:25:46.835Z"} (responds with time)
-```
-
-)
-
----
-
-## 📜 Additional details, mockups, or screenshots
-
-(_If applicable, attach any additional context, mockups, or screenshots that help explain the enhancement_)
-
----
-
-(_Automatically adds the enhancement label for easier tracking_)
-
-/label ~enhancement

package/.gitlab/merge_request_templates/bug_fix.md

@@ -1,9 +0,0 @@
-## 📝 Summary
-
-(_Summarize the bug fix being implemented concisely. "By accepting this MR, you fix X issue."_)
-
----
-
-(_Automatically adds the bug label for easier tracking_)
-
-/label ~bug

package/.gitlab/merge_request_templates/enhancement.md

@@ -1,9 +0,0 @@
-## 📝 Summary
-
-(_Summarize the enhancement concisely. "By accepting this MR, you add X functionality"_)
-
----
-
-(_Automatically adds the enhancement label for easier tracking_)
-
-/label ~enhancement

package/.gitlab-ci.yml

@@ -1,158 +0,0 @@
-########~~~~-- Stages --~~~~########
-
-stages:
-  - secure
-  - test
-  - update
-  - build
-  - deploy
-
-########~~~~-- Variables & defaults --~~~~########
-
-variables:
-  IMAGE: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/node:lts-jod"
-  SCRIPT_TO_INSTALL_DEPS: "apt-get update && apt-get install -y git bash curl jq && npm install -g npm@latest && npm ci"
-
-default:
-  image: $IMAGE
-  interruptible: true
-
-########~~~~-- Workflows --~~~~########
-
-workflow:
-  auto_cancel:
-    on_new_commit: interruptible
-    on_job_failure: all
-  rules:
-    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
-    - if: "$CI_COMMIT_TAG"
-    - if: "$CI_PIPELINE_SOURCE == 'schedule'"
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-
-########~~~~-- Includes --~~~~########
-
-include:
-  - component: "$CI_SERVER_FQDN/beavuck-services/ci-cd-catalog/secret-finder/secret-finder@main"
-    inputs:
-      job_name: "find_secrets"
-      stage_config: "secure"
-
-  - component: "$CI_SERVER_FQDN/beavuck-services/ci-cd-catalog/command-runner/command-runner@main"
-    inputs:
-      job_name: "format"
-      stage_config: ".pre"
-      branch_name: "$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME"
-      command: "npm ci && npm run clean"
-      commit_message: "🎨 Format code automatically"
-      image: "$IMAGE"
-      script_to_install_deps: "$SCRIPT_TO_INSTALL_DEPS"
-      consecutive_command_commits_allowed: false
-
-  - component: "$CI_SERVER_FQDN/beavuck-services/ci-cd-catalog/command-runner/command-runner@main"
-    inputs:
-      job_name: "update"
-      stage_config: "update"
-      branch_name: "chore/update-dependencies"
-      command: "npm run update-dependencies && npm run up-patch"
-      commit_message: "⚙️ Update dependencies automatically"
-      image: "$IMAGE"
-      script_to_install_deps: "$SCRIPT_TO_INSTALL_DEPS"
-      consecutive_command_commits_allowed: true
-
-  - component: "$CI_SERVER_FQDN/beavuck-services/ci-cd-catalog/docker-publisher/docker-publisher@main"
-    inputs:
-      job_name: "publish_to_docker"
-      stage_config: "deploy"
-      image_name: "beavuck/time"
-      publish_to_dockerhub: true
-
-find_secrets:
-  rules: 
-    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-
-update:
-  rules:
-    - if: "$CI_PIPELINE_SOURCE == 'schedule' && $IS_UPDATE == 'true'"
-
-format:
-  rules: 
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-
-publish_to_docker:
-  rules:
-    - if: "$CI_COMMIT_TAG"
-      when: manual
-
-########~~~~-- Jobs --~~~~########
-
-run_integration_tests:
-  stage: test
-  variables:
-    API_PORT: 3000
-    HOST_URL: http://localhost:3000
-    TRUSTED_ORIGINS: http://localhost:8477
-  before_script:
-    - npm install -g npm@latest
-    - npm ci
-    - npm run build
-    - npm start & sleep 10
-  script: npm run run-integration-tests
-  rules:
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-    - if: "$CI_COMMIT_TAG"
-  needs:
-    - job: find_secrets
-      optional: true
-
-coverage:
-  stage: test
-  artifacts:
-    paths: [coverage/lcov.info]
-    reports:
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage/cobertura-coverage.xml
-  before_script: npm install -g npm@latest && npm ci
-  script: npm run test
-  rules:
-    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-    - if: "$CI_COMMIT_TAG"
-  needs:
-    - job: find_secrets
-      optional: true
-
-analyze:
-  stage: test
-  image:
-    name: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/sonarsource/sonar-scanner-cli:latest"
-    entrypoint: [""]
-  cache:
-    key: "${CI_JOB_NAME}"
-    paths: [.sonar/cache]
-  variables:
-    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar" # Defines the location of the analysis task cache
-    GIT_DEPTH: 0 # Tells git to fetch all the branches of the project, required by the analysis task
-  script:
-    - git config --global --add safe.directory "/builds/$CI_PROJECT_PATH"
-    - LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
-    - if [ "$CI_COMMIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]; then PROJECT_VERSION=$LATEST_TAG; else PROJECT_VERSION=$LATEST_TAG-$CI_MERGE_REQUEST_ID; fi
-    - sonar-scanner -Dsonar.projectVersion=$PROJECT_VERSION
-  rules:
-    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
-    - if: "$CI_PIPELINE_SOURCE == 'merge_request_event'"
-  needs:
-    - job: find_secrets
-      optional: true
-    - job: coverage
-      artifacts: true
-
-publish_to_npm:
-  stage: deploy
-  before_script:
-    - echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
-  script: npm publish --access public
-  rules:
-    - if: "$CI_COMMIT_TAG"
-      when: manual

package/.nvmrc

@@ -1 +0,0 @@
-lts/jod

package/.sonarlint/connectedMode.json

@@ -1,4 +0,0 @@
-{
-  "sonarCloudOrganization": "beavuck-services",
-  "projectKey": "beavuck-services_time"
-}

package/DOCKERHUB_OVERVIEW.md

@@ -1,185 +0,0 @@
-# ⏲️ Beavuck Time
-
-## 📊 Status
-
-[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=beavuck-services_time)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=bugs)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
-[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
-[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=beavuck-services_time&metric=coverage)](https://sonarcloud.io/summary/new_code?id=beavuck-services_time)
-
----
-
-## 💡 Why
-
-You can't count on client devices to all be set up with the correct date and time.
-
-But keeping track of time is usually busywork, not the business of your core APIs. And you probably don't want to flood
-your own APIs, whenever you want to get an accurate timestamp for entities in your apps.
-
-So you can set up this simple microservice, whose only job should be to answer the question: "what time is it right
-now?"
-
----
-
-## 🎯 What
-
-Get the current time in ISO format, in UTC timezone.
-
-This lightweight service focuses on one job.
-
-It needs no persistence layer, is capable of handling multiple concurrent requests, and is protected by a simple
-CORS config for security and performance reasons.
-
-Dockerized for easy deployment and scaling.
-
----
-
-## 🔍 Where
-
-The code lives on [GitLab](https://gitlab.com/beavuck-services/time),
-and the Docker image is hosted on [Docker Hub](https://hub.docker.com/r/beavuck/time)
-
-### 🦊 GitLab
-
-You can find the code on GitLab, where, once you have read the [CONTRIBUTING.md](https://gitlab.com/beavuck-services/time/-/blob/main/CONTRIBUTING.md?ref_type=heads) file, you can also
-create issues and merge requests.
-
-Feel free to fork the repo and make your own changes at will, as per the [UNLICENSE](https://gitlab.com/beavuck-services/time/-/blob/main/UNLICENSE?ref_type=heads).
-
-### 🐳 Docker Hub
-
-Most devs will only use Docker Hub for their purposes with this project, to use it as is as a dependency for their own
-projects. On Docker Hub, while you're developing, you should use the `beavuck/time:latest` tag to always get the latest
-version.
-
-When the time comes to go to production, to protect yourself from surprise breaking changes, you should instead point to
-specific minor version tags, such as `beavuck/time:2.0` : those will not get breaking changes, but they will get
-security updates and bug fixes while they're active.
-
----
-
-## ⚙️ Usage
-
-### 🪧 Set up (docker-compose example)
-
-To run the service in a docker-compose environment, add this in your `docker-compose.yml`'s services section:
-
-```yaml
-time:
-    image: beavuck/time:latest
-    ports:
-        - 'SOME_PORT_NUMBER:3000'
-        # HOST_PORT:CONTAINER_PORT (Since we are in a container, CONTAINER_PORT corresponds to the API_PORT variable below)
-    environment:
-        - BEAVUCK_TIME_HOST_URL: https://time-api.example.com
-        # BEAVUCK_TIME_HOST_URL: That API's URL. Essential for CORS config.
-        - BEAVUCK_TIME_TRUSTED_ORIGINS: https://my.app.com,https://my-other.app.com
-        # BEAVUCK_TIME_TRUSTED_ORIGINS: To allow requests from any origin, include * (not recommended). If empty, will only allow requests from the HOST_URL's origin. Defaults to the HOST_URL's origin
-        - BEAVUCK_TIME_API_PORT: 3000
-        # BEAVUCK_TIME_API_PORT: Optional. Internal port when in a container. Defaults to 3000
-        - BEAVUCK_TIME_RATE_LIMIT: 100
-        # BEAVUCK_TIME_RATE_LIMIT: Optional. Max allowed number of requests per minute for each IP address. If negative or 0, no limit. Defaults to no limit
-        - BEAVUCK_TIME_LOG_LEVEL: info
-        # BEAVUCK_TIME_LOG_LEVEL: Optional. Logging levels include error, warn, info, http, verbose, debug, silly. Defaults to info
-        - BEAVUCK_TIME_MAX_LOG_FILES: 64
-        # BEAVUCK_TIME_MAX_LOG_FILES: Optional. Maximum number of logs to keep. This can be a number of files or number of days. If using days, add 'd' as the suffix. Default is 64
-        - BEAVUCK_TIME_MAX_SIZE_LOG_FILES: 1m
-        # BEAVUCK_TIME_MAX_SIZE_LOG_FILES: Optional. Maximum size of the file after which it will rotate. This can be a number of bytes, or units of kb, mb, and gb. If using the units, add 'k', 'm', or 'g' as the suffix. The units need to directly follow the number. Default is 1m
-```
-
-Here's the simple docker compose file I used to test this service locally:
-
-```yaml
-services:
-    time:
-        image: beavuck/time:latest
-        ports:
-            - '3000:3000'
-        environment:
-            BEAVUCK_TIME_HOST_URL: http://127.0.0.1:3000
-            BEAVUCK_TIME_TRUSTED_ORIGINS: http://127.0.0.1:8000,http://localhost:8000
-            BEAVUCK_TIME_LOG_LEVEL: debug
-```
-
-When you're ready, just run your services with:
-
-```shell
-docker compose up -d
-```
-
-### ✨ Using the service
-
-Now, when you run:
-
-```shell
-curl --location 'http://localhost:{{SOME_PORT_NUMBER}}/now' \
---header 'Origin: {{SOME_TRUSTED_ORIGIN}}'
-```
-
-you should expect an answer such as:
-
-```json
-{
-    "now": "2024-06-15T12:35:48.022Z"
-}
-```
-
----
-
-## 🛡️ CORS
-
-This service is protected by a CORS policy, which you can configure by setting the `TRUSTED_ORIGINS` environment
-variable.
-
-When you use the API, keep in mind what roles these headers play:
-
-| `"Origin:"`                                               | `"Referrer:"`*                 | Result |
-| --------------------------------------------------------- | ------------------------------ | ------ |
-| Defined and API `BEAVUCK_TIME_TRUSTED_ORIGINS` set to `*` | Whatever                       | ✅     |
-| Trusted                                                   | Whatever                       | ✅     |
-| Same as this API's host                                   | Whatever                       | ✅     |
-| Not defined                                               | Same as this API's host        | ✅     |
-| Defined and not trusted                                   | Whatever                       | 🛑     |
-| Not defined                                               | Not defined                    | 🛑     |
-| Not defined or not trusted                                | Different from this API's host | 🛑     |
-* AKA `Referer` (sic).
----
-
-## 📚 Use cases
-
-### Batch `POST`s
-
-Suppose you're creating timestamped entities in your app, and you want to send them in a batch to your API. Your API
-knows the current time when it gets the request, but not the creation time of each entity.
-
-![](https://www.mermaidchart.com/raw/d089f4b4-f7d8-4901-b257-5fcdbb258629?theme=dark&version=v0.1&format=svg)
-
-And querying your core API for the current time for each entity is a waste of resources -- that's why you're batching
-the operation in the first place.
-
-![](https://www.mermaidchart.com/raw/3a8e339e-151d-4e7b-aa4d-114f17d1bb72?theme=dark&version=v0.1&format=svg)
-
-So you can use this service to get the current time whenever you need it, and use that as the creation time for each
-entity.
-
-![](https://www.mermaidchart.com/raw/81c7ad4f-7462-4c95-8da3-1c1d3c0ac4f7?theme=dark&version=v0.1&format=svg)
-
----
-
-## 📜 License
-
-Have at it.
-
-This project uses the Unlicense. See the [UNLICENSE](https://gitlab.com/beavuck-services/time/-/blob/main/UNLICENSE?ref_type=heads) file for details.

package/Dockerfile

@@ -1,25 +0,0 @@
-FROM node:jod-alpine
-
-WORKDIR /usr/src/app
-
-COPY package*.json tsconfig.json tsoa.json ./
-COPY src ./src
-COPY .env ./.env
-
-# building the app
-RUN npm install --ignore-scripts -g npm@latest \
-&& npm ci --ignore-scripts \
-&& npm run build \
-# managing user permissions
-&& apk add --no-cache shadow \
-&& groupadd -r appgroup \
-&& useradd -r -g appgroup appuser \
-&& chown -R appuser:appgroup /usr/src/app \
-# making the image smaller by removing npm
-&& npm uninstall -g npm
-
-USER appuser
-
-EXPOSE 3000
-
-CMD ["node", "build/server.js"]

package/HELP.md

@@ -1,53 +0,0 @@
-# Beavuck Time
-
-## Usage
-
-### Set up (outside a container)
-
-Install the dependencies, and run the service with:
-
-```shell
-npm install
-npm run go
-```
-
-### Managing environment variables
-
-Environment variables are encrypted. Check out https://dotenvx.com/docs/quickstart to manage them if needed
-
-### Using the service
-
-When you run:
-
-```shell
-curl --location 'http://localhost:3000/now' \
---header 'Origin: http://localhost:8477'
-```
-
-you should expect an answer such as:
-
-```json
-{
-    "now": "2024-06-14T18:25:46.835Z"
-}
-```
-
-### Testing
-
-#### Node tests
-
-To run the tests, you can use:
-
-```shell
-npm test
-```
-
-#### API client tests
-
-Check out the `run-integration-tests` script in the `package.json` file. If you run the API then run the tests, you
-should see the tests pass.
-
-We write those tests using [Bruno](https://docs.usebruno.com/), because Postman is whack and bloaty and impossible to 
-version cleanly within a repo.
-
-Bruno is pretty neat -- it's made by devs for devs and it has a lot to offer right now, as well as a lot of promise.

package/api-tests/bruno/bruno.json

@@ -1,9 +0,0 @@
-{
-  "version": "1",
-  "name": "Time",
-  "type": "collection",
-  "ignore": [
-    "node_modules",
-    ".git"
-  ]
-}

package/api-tests/bruno/collection.bru

@@ -1,7 +0,0 @@
-meta {
-  name: Time
-}
-
-auth {
-  mode: none
-}

package/api-tests/bruno/environments/local.bru

@@ -1,8 +0,0 @@
-vars {
-  BASE_URL: http://localhost:3000
-  TRUSTED_ORIGIN: http://localhost:8477
-  NON_TRUSTED_ORIGIN: http://localhost:9632
-  NON_RECOGNIZED_REFERRER: http://localhost:9236
-  RFC_3339_REGEX: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$
-  CORS_REGEX: [cC][oO][rR][sS]
-}

package/api-tests/bruno/now/nok/nok_no_origin.bru

@@ -1,19 +0,0 @@
-meta {
-  name: nok_no_origin
-  type: http
-  seq: 2
-}
-
-get {
-  url: {{BASE_URL}}/now
-  body: none
-  auth: inherit
-}
-
-assert {
-  res.status: eq 403
-  res.body: isDefined
-  res.body.message: isDefined
-  res.body.message: matches {{CORS_REGEX}}
-  res.responseTime: lt 200
-}

package/api-tests/bruno/now/nok/nok_non_recognized_referrer.bru

@@ -1,23 +0,0 @@
-meta {
-  name: nok_non_recognized_referrer
-  type: http
-  seq: 4
-}
-
-get {
-  url: {{BASE_URL}}/now
-  body: none
-  auth: inherit
-}
-
-headers {
-  Referrer: {{NON_RECOGNIZED_REFERRER}}
-}
-
-assert {
-  res.status: eq 403
-  res.body: isDefined
-  res.body.message: isDefined
-  res.body.message: matches {{CORS_REGEX}}
-  res.responseTime: lt 200
-}

package/api-tests/bruno/now/nok/nok_non_trusted_origin.bru

@@ -1,23 +0,0 @@
-meta {
-  name: nok_non_trusted_origin
-  type: http
-  seq: 1
-}
-
-get {
-  url: {{BASE_URL}}/now
-  body: none
-  auth: inherit
-}
-
-headers {
-  Origin: {{NON_TRUSTED_ORIGIN}}
-}
-
-assert {
-  res.status: eq 403
-  res.body: isDefined
-  res.body.message: isDefined
-  res.body.message: matches {{CORS_REGEX}}
-  res.responseTime: lt 200
-}

package/api-tests/bruno/now/nok/nok_non_truted_origin_nor_referrer.bru

@@ -1,24 +0,0 @@
-meta {
-  name: nok_non_truted_origin_nor_referrer
-  type: http
-  seq: 3
-}
-
-get {
-  url: {{BASE_URL}}/now
-  body: none
-  auth: inherit
-}
-
-headers {
-  Origin: {{NON_TRUSTED_ORIGIN}}
-  Referrer: {{NON_RECOGNIZED_REFERRER}}
-}
-
-assert {
-  res.status: eq 403
-  res.body: isDefined
-  res.body.message: isDefined
-  res.body.message: matches {{CORS_REGEX}}
-  res.responseTime: lt 200
-}