TGR-50: Remediation update

.env-sample

@@ -21,11 +21,15 @@ BASE_URL=/research/research-catalog
 REDIRECT_FROM_BASE_URL=/research/collections/shared-collection-catalog
 WEBPAC_BASE_URL=https://[fqdn]/
 LOGIN_BASE_URL=https://[fqdn]/
+LOGIN_URL=https://[fqdn]/
 CIRCULATING_CATALOG=https://[fqdn]/
 OPEN_LOCATIONS=315,300
 SHEP_BIBS_LIMIT=25
 TZ=America/New_York
 LAUNCH_EMBED_URL=https://[fqdn]/
 NYPL_HEADER_URL=https://ds-header.nypl.org
 SIERRA_UPGRADE_AUG_2023=true
-REVERSE_PROXY_ENABLED=false
+REVERSE_PROXY_ENABLED=false
+DRB_API_BASE_URL=https://[fqdn]/
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=

.eslintrc

@@ -18,7 +18,6 @@
       "impliedStrict": true,
       "jsx": true
     },
-    "ecmaVersion": 2019,
     "sourceType": "module",
     "project": "./tsconfig.json"
   },

.github/workflows/ci.yml

@@ -0,0 +1,97 @@
+# Run tests and deploy to QA and Production on `nypl-digital-dev` account
+
+name: CI
+
+on: push
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Cache and install node modules
+        uses: bahmutov/npm-install@v1
+        with:
+          install-command: npm install --ignore-script
+      - name: Test
+        run: npm run test
+  publish_qa:
+    needs: test
+    # TODO: update this to `qa` branch
+    if: github.ref == 'refs/heads/TGR-50/remediation-update'
+    name: Publish image to ECR and update ECS stack
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          role-to-assume: arn:aws:iam::946183545209:role/GithubActionsDeployerRole
+          aws-region: us-east-1
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v1
+
+      - name: Build, tag, and push image to Amazon ECR
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          ECR_REPOSITORY: nypl-discovery-ui
+          IMAGE_TAG: ${{ github.sha }}
+        run: |
+          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
+          docker tag $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG $ECR_REGISTRY/$ECR_REPOSITORY:qa-latest
+          docker push $ECR_REGISTRY/$ECR_REPOSITORY:qa-latest
+
+      - name: Force ECS Update
+        # Deploy to both the production and train clusters
+        run: |
+          aws ecs update-service --cluster nypl-discovery-qa-tf --service nypl-discovery-qa-tf --force-new-deployment
+          aws ecs update-service --cluster nypl-discovery-train-tf --service nypl-discovery-train-tf --force-new-deployment
+  publish_production:
+    needs: test
+    if: github.ref == 'refs/heads/tgr-production'
+    name: Publish image to ECR and update ECS stack
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          role-to-assume: arn:aws:iam::946183545209:role/GithubActionsDeployerRole
+          aws-region: us-east-1
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v1
+
+      - name: Build, tag, and push image to Amazon ECR
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          ECR_REPOSITORY: nypl-discovery-ui
+          IMAGE_TAG: ${{ github.sha }}
+        run: |
+          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
+          docker tag $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG $ECR_REGISTRY/$ECR_REPOSITORY:production-latest
+          docker push $ECR_REGISTRY/$ECR_REPOSITORY:production-latest
+
+      - name: Force ECS Update
+        run: |
+          aws ecs update-service --cluster nypl-discovery-production-tf --service nypl-discovery-production-tf --force-new-deployment

.gitignore

@@ -16,11 +16,6 @@ log/*.log
 # Local env:
 .env
 
-# Elastic Beanstalk Files
-.elasticbeanstalk/*
-!.elasticbeanstalk/*.cfg.yml
-!.elasticbeanstalk/*.global.yml
-
 #Files with names of missing fields
 
 # VS code Configuration Files

.nvmrc

@@ -1 +1 @@
-10.17.0
+20

CHANGELOG.md

@@ -1,5 +1,36 @@
 ## CHANGE LOG
 
+### 1.9.0
+
+Remediation Project Update
+
+### Adds
+
+- Adds `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` as example env vars needed in `.env-sample`. They are required for building Docker images.
+- Adds `Dockerfile` and instructions on how to use it locally.
+- Adds the following npm packages:
+  `sass`, `webpack-dev-middleware`
+
+### Updates
+
+- Updates `.nvmrc` to use Node 20.
+- Updates the logger file.
+- Updates npm scripts to be more conventional with `build` and `dev`.
+- Updates how the webpack dev server is implemented.
+- Updates how the `react-number-format` package is used in the `FieldsetDate` component.
+- Updates implementation of the `focus-trap-react` package.
+- Updates node's Buffer implementation for KMS package usage.
+- Updates the following npm packages:
+  `@babel/preset-env`, `@babel/preset-react`, `@babel/preset-register`, `@nypl/nypl-core-objects`, `@nypl/nypl-data-api-client`, `@typescript-eslint/eslint-plugin`, `axios`, `babel-plugin-module-resolver`, `body-parser`, `chai`, `clean-webpack-plugin`, `compression`, `cookie-parser`, `cross-env`, `css-loader`, `doctoc`, `dotenv`, `ejs`, `enzyme-adapter-react-16`, `eslint`, `eslint-config-airbnb`, `eslint-config-prettier`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-prettier`, `eslint-plugin-react`, `eslint-plugin-react-hooks`, `express`, `file-loader`, `focus-trap-react`, `jsonwebtoken`, `mini-css-extract-plugin`, `mocha`, `mock-local-storage`, `nock`, `react`, `react-autosuggest`, `react-dom`, `react-number-format`, `react-redux`, `redux`, `redux-thunk`, `prettier`, `sass-loader`, `sinon`, `sinon-chai`, `style-loader`, `supertest`, `typescript`, `webpack`, `webpack-cli`, `winston`, `underscore`, `url-parse`, `validator`
+
+### Removals
+
+- Removes the `.ebextensions` folder since this repos should no longer deploy to ElasticBeanstalk.
+- Removes the `.travis.yml` file to not use Travis CI.
+- Removes the `Procfile` since this we don't use Heroku.
+- Removes the following npm packages:
+  `@babel/core`, `@babel/polyfill`, `@nypl/dgx-header-component`, `@nypl/dgx-react-footer`, `@typescript-eslint/parser`, `node-sass`, `node-sass-glob-importer`, `react-router-scroll`, `webpack-bundle-analyzer`, `webpack-dev-server`, `webpack-merge`
+
 ### 1.8.2
 
 ### Updates

DEPLOYMENT.md

@@ -5,7 +5,6 @@
 Install:
 
 - AWS CLI
-- EB CLI
 
 ### Repo Branches
 
@@ -33,42 +32,6 @@ If we have a new feature to add, the suggested workflow is:
 
 Once a feature branch has been approved and merged into development
 
-### Elastic Beanstalk
-
-There are two existing AWS accounts that we are deploying to for development and for qa/production.
-
-Make sure you have the AWS CLI tool installed on your machine and make sure you have the correct credentials for the two accounts. Since we have two accounts, nypl-sandbox and nypl-digital-dev, make sure you create two profiles using the AWS CLI tool:
-
-    aws configure --profile nypl-digital-dev
-
-Pass in the correct credentials and now we can start deploying.
-
-### Configuration
-
-Run `eb init` at the root of this repo with the following settings:
-
-- Select region 'us-east-1'
-- Select application 'discovery-ui'
-- Select default environment 'discovery-ui-development'
-- If asked about CodeCommit, select 'n'
-- If asked if you want to set up SSH for your instances, select 'n'
-- Now manually edit `.elasticbeanstalk/config.yml` to include the following `branch-defaults`:
-
-```
-branch-defaults:
-  dev-eb-deploy:
-    environment: discovery-ui-development
-    group_suffix: null
-  master:
-    environment: discovery-ui-production
-    group_suffix: null
-  qa:
-    environment: discovery-ui-qa
-    group_suffix: null
-```
-
-Note that `development` will always differ from `qa` in one respect: Apps deployed to `nypl-sandbox` require a different cert ARN than that for `nypl-digital-dev`. Accordingly, `development` will always have a slightly different `.ebextensions/01_loadbalancer-terminatehttps.config` from that of `qa`. Due to the order in which those differences were originally committed, merging `development` into `qa` should never disrupt that.
-
 ### Deployment
 
 |                  | Development              | QA               | Production              |
@@ -104,9 +67,3 @@ _(Note that updates to origin/master trigger a deploy to discovery-ui-production
 
 - `git checkout master`, `git merge qa`, `git push origin master`
 - Run `npm run deploy-production`
-
-### Troubleshooting
-
-#### Python error: "ERROR: TypeError :: cannot concatenate 'str' and 'NoneType' objects"
-
-This may indicate your `.elasticbeanstalk/config.yml` is missing a value or two. Try running `eb init` to fill in missing values. See "Configuration" section above for best defaults.

Dockerfile

@@ -0,0 +1,25 @@
+# Build the environment.
+FROM node:20-alpine as production
+
+WORKDIR /app
+
+ENV NODE_ENV=production
+ENV TZ=America/New_York
+
+# Install dependencies.
+COPY package.json ./
+COPY package-lock.json ./
+RUN npm install --force
+
+# Copy the app files.
+COPY . .
+COPY .env .env
+
+
+# Build the app!
+RUN npm run build
+
+EXPOSE 3001
+
+# CMD is the default command when running the docker container.
+CMD npm start