Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mdvanes/homeremote-server

NestJS API for Homeremote web app
https://github.com/mdvanes/homeremote-server

Last synced: 10 months ago
JSON representation

NestJS API for Homeremote web app

Awesome Lists containing this project

README 

          
# Homeremote API



NestJS API for [Homeremote](https://github.com/mdvanes/homeremote) web app.

Build with [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.



## Installation



```bash

$ yarn

```



Note:

https://stackoverflow.com/questions/53963007/error-while-running-nestjs-in-production-mode-cannot-find-module#54049216

import { EntityService } from '../shared/service-common'; //correct way

import { EntityService } from 'src/shared/service-common'; // wrong autoimport

To fix auto import, I have added this setting in VS Code 

"typescript.preferences.importModuleSpecifier": "relative"

> OK, but why does this only happen for NestJS?



## Development flow



## Without nginx proxy (requires development mode CORS settings on client and server)



* Start dev API server: `yarn start:dev-temp`, this will run on port 3001 (prod on port 3200)

* In the UI project start the dev webpack server with `yarn start:dev`, this will run on port 3000

* Open browser on http://localhost:3000

* Dockerlist and nowplaying do not yet send the `credentials: include` flag, so they give unauthorized errors



## With nginx proxy



* on client, use .env.development.local with REACT_APP_BASE_URL=http://localhost:3002

* start nginx proxy: `yarn start:dev-nginx` (see NGINX chapter), this will run on port 3002

* in same terminal, start dev API server: `yarn start:dev-temp`, this will run on port 3001 (prod on port 3200)

* in the UI project start the dev webpack server with `yarn start:dev`, this will run on port 3000

* Open browser on http://localhost:3002

* generate a new route (i.e. controller), e.g. /api/switches with `nest g co switches`

* add prefix `api/` manually in /switches/switches.controller.ts



## Adding a user



* This endpoint is only enabled in development mode

* Start dev server: `yarn start:dev-temp`

* For password "test", call (e.g. in browser) `http://localhost:3001/api/pw-to-hash/?password=test`

* Store the hash with the username in auth.json



## Deployment Strategy



Old deployment flow (to local machine):



* if never done before, copy the full `homeremote-nestjs-server` dir to a new `homeremote-v2-dist` dir, including `node_modules`, `src`, root files, etc.

* in `homeremote-v2` (client) dir, run `yarn build` (prebuild should run, running unit tests and linting)

* run `yarn deploy` (copies generated `build` dir to `homeremote-nestjs-server/client`)

* in `homeremote-nestjs-server` (server) dir, run `yarn build` (prebuild should run, running unit tests and linting)

* run `yarn deploy` (copies generated `dist` dir to `homeremote-v2-dist/dist`)

* ? potentially clean `homeremote-v2-dist` dir and reset everything from step 1?

* in `homeremote-v2-dist` dir, update `.env` if needed

* in `homeremote-v2-dist` dir, run `nvm use 15 && node dist/src/main`



Deployment Strategy (Docker)



1. Make sure there is a file `repos/hr/build-docker/build.sh`:

    ```bash

    #!/bin/bash

    set -euo pipefail

    IFS=$'\n\t'



    source ~/.nvm/nvm.sh

    nvm use 15



    # git pull to latest

    git -C homeremote pull

    git -C homeremote-server pull



    cd homeremote

    yarn --frozen-lockfile

    yarn build



    cd ..

    docker build -t mdworld/homeremote:latest -f homeremote-server/Dockerfile .

    docker save mdworld/homeremote:latest -o mdworld_homeremote__latest.tar

    ```

1. Update the versions in package.json in client and server repo

1. Build client and server to check build will succeed

1. Tag client and server with the new version number: `git tag -a v2.0.0 -m "publish version 2.0.0"`

1. Push client and server with tags: `git push --follow-tags`

1. Run `./build.sh` in the `build-docker` dir (this also exports to .tar)

1. Set up /someDir/repos/hr/build-docker/settings/ with .env and auth.json

1. To run locally: create and run a file `./run.sh` that runs a configured `docker run...` (see comment in Dockerfile)

1. Create and run a file `./copyToServer.sh` to copy exported .tar to the server

1. On the server, set up /someDir/hr/settings/ with .env and auth.json

1. Create/check `/someDir/hr/updateHomeremote.sh` and `chmod +x` it:

    ```bash

    #!/bin/bash

    set -euo pipefail

    IFS=$'\n\t'



    TAR_PATH=/REPLACE_THIS_PATH



    docker stop homeremote

    docker rm homeremote

    docker rmi mdworld/homeremote:latest

    ls $TAR_PATH -lh | grep mdworld_homeremote__latest

    docker load -i $TAR_PATH/mdworld_homeremote__latest.tar



    # Sync this with documentation in "system guides", differs in path after $(pwd) because this file is in hr dir

    docker run -d --name homeremote \

        --env-file $(pwd)/settings/.env \

        -v $(pwd)/settings/auth.json:/app/dist/auth.json \

        -v /mnt/disk3t/Media/Music/Various/Songs\ from/:/songsfrom \

        -v /var/run/docker.sock:/var/run/docker.sock \

        -p 3000:3200 \

        --restart unless-stopped \

        mdworld/homeremote:latest



    docker ps | grep homeremote

    ```

1. Run `./updateHomeremote.sh`

1. Smoketest the application in the browser

1. If not working: restart tab, logout/login, use the navigation menu, clear service worker.



TODO?



* automate these steps with one script (but opt-out of version bump/tagging when debugging?):

    1. Update the versions in package.json in client and server repo

    1. Build client and server to check build will succeed

    1. Tag client and server with the new version number: git tag -a v2.0.0 -m "publish version 2.0.0"

    1. Push client and server with tags: git push --follow-tags

* unrelated: https://github.com/creack/docker-firefox/blob/master/Dockerfile -> https://docs.docker.com/engine/reference/commandline/build/#build-with-url

* automate: when version changes, set a tag in git

* https://docs.docker.com/engine/reference/commandline/build/#git-repositories

    * e.g.: `docker build https://github.com/mdvanes/myrepo.git#mytag:myfolder`

* in Docker? Multi stage build? https://medium.com/@basakabhijoy/dockerise-a-nestjs-app-2b7f42fc333f

* how to add client dist to server dist?

* when this runs in a Docker container, will it still be able to access other Docker containers?

    * difficult when doing "exec" from node, e.g. to do `docker ps -as --format='{{json .}}'` (see system guides for more commands)

    * Using Docker Engine API: curl --unix-socket /var/run/docker.sock http:/v1.24/containers/json?all=true

        * [{"Id":"e0c4e45edf36fbaf2b07b1248c5c169de6ded19b8297251d96d90f45409b4036","Names":["/portainer"],"Image":"portainer/portainer","ImageID":"sha256:62771b0b9b0973a3e8e95595534a1240d8cfd968d30ec82dc0393ce0a256c5f3","Command":"/portainer","Created":1596817545,"Ports":[{"IP":"0.0.0.0","PrivatePort":8000,"PublicPort":8000,"Type":"tcp"},{"IP":"0.0.0.0","PrivatePort":9000,"PublicPort":9000,"Type":"tcp"}],"Labels":{},"State":"running","Status":"Up 6 days","HostConfig":{"NetworkMode":"default"},"NetworkSettings":{"Networks":{"bridge":{"IPAMConfig":null,"Links":null,"Aliases":null,"NetworkID":"5c4e60ee78497152bb5ae636c2fd5eb4979c79df95b49569309b7427da807d76","EndpointID":"cecdb1db8f7d48ed0f847014d331ce42b161bc6a4a953b1f5bf4b69c096158bc","Gateway":"172.17.0.1","IPAddress":"172.17.0.2","IPPrefixLen":16,"IPv6Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"MacAddress":"02:42:ac:11:00:02","DriverOpts":null}}},"Mounts":[{"Type":"bind","Source":"/var/run/docker.sock","Destination":"/var/run/docker.sock","Mode":"","RW":true,"Propagation":"rprivate"},{"Type":"volume","Name":"portainer_data","Source":"/var/lib/docker/volumes/portainer_data/_data","Destination":"/data","Driver":"local","Mode":"z","RW":true,"Propagation":""}]}]



## Nginx docker container for development



Because forwarding http-only cookie only works on the same domain (with current settings [insert links to article here]), use this NGINX container

that forwards traffic from both the front-end and the back-end from the same port.



Before running `yarn start:dev` (for the server), in the same terminal run:



* `yarn start:dev-nginx`

* `docker ps` and visit localhost:3002



Notes:



* Authentication Testing Dashboard can't be reached with this proxy, just use http://localhost:3001/

* Add the current host IP to docker: docker run --add-host localnode:192.168.0.17

* Get current IP with `ifconfig eth0 | grep inet | grep -v inet6 | awk '{print $2}'` (or see this for automatic: https://stackoverflow.com/questions/27810076/how-do-i-access-a-server-on-localhost-with-nginx-docker-container)

* The nginx.conf is read from this dir

* In nginx.conf proxypass use localnode instead of localhost.



## Running the app



```bash

# development

$ yarn start:dev-nginx

$ yarn start



* and open http://localhost:3000/auth/login

* log in with flap/1

* create hash from password: http://localhost:3000/api/gethash?password=test



# watch mode

$ yarn start:dev



# production mode

$ yarn start:prod

```



## Test



```bash

# unit tests

$ yarn test



# e2e tests

$ yarn test:e2e



# test coverage

$ yarn test:cov

```