Extract reference data service from monorepo

Dockerfile

@@ -0,0 +1,20 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
+
+WORKDIR /reference-data
+COPY . .
+EXPOSE 18085
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+ARG EXTRA_NODE_VERSION=18
+RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>"
+RUN npm install
+ENTRYPOINT npm run start

README.md

@@ -1,2 +1,96 @@
-# traderXReferenceDataService
-Microservice containing the reference data service from the TraderXCognitionDemos repo
+# FINOS | TraderX Sample Trading App | Reference Data Service
+
+![DEV Only Warning](https://badgen.net/badge/warning/not-for-production/red) ![Local Dev Machine Supported](http://badgen.net/badge/local-dev/supported/green)
+
+The Reference Data service provides a list of stock tickers and their associated company names via a RESTful interface.
+
+## Prerequisites
+
+This project assumes that your environment is already configured to use node and npm
+
+By default this will run the application on localhost, port 18085, however the hostname and port can be modified by the following environment variables:
+
+| Environment Variable Name  | Default Value    |
+| -------------------------  | ---------------- |
+| REFERENCE_DATA_SERVICE_PORT| 18085             |
+| HOSTNAME                   | localhost        |
+
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+If you are developing the Reference Data service you can use the **start:dev** script instead. This runs with file
+watchers that will automatically rebuild and redeploy the application when the code changes:
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+
+
+##  Testing
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+
+## Accessing the Reference Data service
+
+Assuming the Reference Data service is running from the default location, otherwise modify the hostname and/or port
+accordingly, then the following links are available:
+ - http://localhost:18085/api/ - the OpenAPI UI
+ - http://localhost:18085/stocks - the reference data
+ - http://localhost:18085/stocks/:ticker - the reference data for a specific ticker (or 404 if it does not exist)
+
+ ## S&P 500 companies
+
+The [CSV of S&P 500 companies](./data/s-and-p-500-companies.csv) was populated by copying the data from
+[this table from Wikipedia](https://en.wikipedia.org/wiki/List_of_S%26P_500_companies#S&P_500_component_stocks).
+
+
+
+## Simple Testing of Reference Data Service`
+
+Obviously this is a lightweight nodeJS service, which you can run, but if you prefer, you can also run a mock of this service by installing `@stoplight/prism-cli`
+
+This statically uses the example content in the OpenAPI spec to mock the service (you can specify `--dynamic` to let it be more creative)
+
+```bash
+# Only need to do this once for your machine
+sudo npm install -g @stoplight/prism-cli
+```
+
+Run prism to mock your OpenAPI spec as follows (Specify `port` as you see fit).
+ecurities is random on each request).
+
+```bash
+prism --cors --port 18085  mock openapi.yaml
+```
+
+You can then try out your requests against the mock service as follows: (or from a browser)
+
+```bash
+curl -X GET "http://localhost:18085/stocks" -H "accept: application/json"
+curl -X GET "http://localhost:18085/stocks/ADBE" -H "accept: application/json"
+
+```

base.Dockerfile

@@ -0,0 +1,55 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=20-bullseye
+FROM node:${VARIANT}
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+
+# Install needed packages, yarn, nvm and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=node
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+ARG NPM_GLOBAL=/usr/local/share/npm-global
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \ 
+    PATH=${NPM_GLOBAL}/bin:${NVM_DIR}/current/bin:${PATH}
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, update yarn and install nvm
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    # Install yarn, nvm
+    && rm -rf /opt/yarn-* /usr/local/bin/yarn /usr/local/bin/yarnpkg \
+    && bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "none" "${USERNAME}" \
+    # Configure global npm install location, use group to adapt to UID/GID changes
+    && if ! cat /etc/group | grep -e "^npm:" > /dev/null 2>&1; then groupadd -r npm; fi \
+    && usermod -a -G npm ${USERNAME} \
+    && umask 0002 \
+    && mkdir -p ${NPM_GLOBAL} \
+    && touch /usr/local/etc/npmrc \
+    && chown ${USERNAME}:npm ${NPM_GLOBAL} /usr/local/etc/npmrc \
+    && chmod g+s ${NPM_GLOBAL} \
+    && npm config -g set prefix ${NPM_GLOBAL} \
+    && sudo -u ${USERNAME} npm config -g set prefix ${NPM_GLOBAL} \
+    # Install eslint
+    && su ${USERNAME} -c "umask 0002 && npm install -g eslint" \
+    && npm cache clean --force > /dev/null 2>&1 \
+    # Install python-is-python3 on bullseye to prevent node-gyp regressions
+    && . /etc/os-release \
+    && if [ "${VERSION_CODENAME}" = "bullseye" ]; then apt-get -y install --no-install-recommends python-is-python3; fi \
+    # Clean up
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/* /root/.gnupg /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>""