Merge pull request #219 from 18F/develop

Version Routing in support of UA to GA4 migration

Author: XavierMetichecchia

.circleci/config.yml

@@ -1,4 +1,4 @@
-version: 2.1  
+version: 2.1
 jobs:
   develop_deploy:
     docker:
@@ -11,25 +11,25 @@ jobs:
           POSTGRES_DB: analytics-api-test
     steps:
       - checkout
-      
+
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "package.json" }}
             - v1-dependencies-
-      
+
       - run:
           name: install dependencies
           command: npm install
-      
+
       - save_cache:
           paths:
             - ./node_modules
           key: v1-dependencies-{{ checksum "package.json" }}
-      
+
       - run:
            name: run tests
            command: npm test
-       
+
       - run:
           name: Replace Data URL in manifest.yml file when deploying to develop
           command: |
@@ -51,14 +51,14 @@ jobs:
               rm ./src/config.js
               mv ./src/config.js.cloudgov ./src/config.js
               rm knexfile.js
-              mv knexfile.js.cloudgov knexfile.js 
+              mv knexfile.js.cloudgov knexfile.js
 
-      - run:   
+      - run:
           name: Install CF CLI
           command: |
               sudo curl -v -L -o cf8-cli-installer_8.7.4_x86-64.deb 'https://packages.cloudfoundry.org/stable?release=debian64&version=8.7.4'
               sudo dpkg -i cf8-cli-installer_8.7.4_x86-64.deb
-      
+
       - run:
           name: deploy
           command: |
@@ -68,7 +68,7 @@ jobs:
               cf login -u $CF_USERNAME_DEV -p $CF_PASSWORD_DEV -o gsa-opp-analytics -s analytics-dev
               cat manifest.yml
               cf push -f "./manifest.yml"
-              cf set-env analytics-reporter-api-develop API_DATA_GOV_SECRET "$API_SECRET"
+              cf set-env analytics-reporter-api-develop API_DATA_GOV_SECRET "$API_SECRET_LOWER"
               cf restage analytics-reporter-api-develop
               cf logout
 
@@ -83,25 +83,25 @@ jobs:
           POSTGRES_DB: analytics-api-test
     steps:
       - checkout
-      
+
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "package.json" }}
             - v1-dependencies-
-      
+
       - run:
           name: install dependencies
           command: npm install
-      
+
       - save_cache:
           paths:
             - ./node_modules
           key: v1-dependencies-{{ checksum "package.json" }}
-      
+
       - run:
            name: run tests
            command: npm test
-       
+
       - run:
           name: Replace Data URL in manifest.yml file when deploying to staging
           command: |
@@ -125,12 +125,12 @@ jobs:
               rm ./src/config.js
               mv ./src/config.js.cloudgov ./src/config.js
 
-      - run:   
+      - run:
           name: Install CF CLI
           command: |
               sudo curl -v -L -o cf8-cli-installer_8.7.4_x86-64.deb 'https://packages.cloudfoundry.org/stable?release=debian64&version=8.7.4'
               sudo dpkg -i cf8-cli-installer_8.7.4_x86-64.deb
-      
+
       - run:
           name: deploy
           command: |
@@ -140,7 +140,7 @@ jobs:
               cf login -u $CF_STAGING_SPACE_DEPLOYER_USERNAME -p $CF_STAGING_SPACE_DEPLOYER_PASSWORD -o gsa-opp-analytics -s analytics-staging
               cat manifest.yml
               cf push -f "./manifest.yml"
-              cf set-env analytics-reporter-api-staging API_DATA_GOV_SECRET "$API_SECRET"
+              cf set-env analytics-reporter-api-staging API_DATA_GOV_SECRET "$API_SECRET_LOWER"
               cf restage analytics-reporter-api-staging
               cf logout
 
@@ -155,25 +155,25 @@ jobs:
           POSTGRES_DB: analytics-api-test
     steps:
       - checkout
-      
+
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "package.json" }}
             - v1-dependencies-
-      
+
       - run:
           name: install dependencies
           command: npm install
-      
+
       - save_cache:
           paths:
             - ./node_modules
           key: v1-dependencies-{{ checksum "package.json" }}
-      
+
       - run:
            name: run tests
            command: npm test
-       
+
       - run:
           name: Replace Data URL in manifest.yml file when deploying to production
           command: |
@@ -197,12 +197,12 @@ jobs:
               rm ./src/config.js
               mv ./src/config.js.cloudgov ./src/config.js
 
-      - run:   
+      - run:
           name: Install CF CLI
           command: |
               sudo curl -v -L -o cf8-cli-installer_8.7.4_x86-64.deb 'https://packages.cloudfoundry.org/stable?release=debian64&version=8.7.4'
               sudo dpkg -i cf8-cli-installer_8.7.4_x86-64.deb
-      
+
       - run:
           name: deploy
           command: |
@@ -218,23 +218,23 @@ jobs:
 
 workflows:
   develop_workflow:
-    jobs: 
+    jobs:
       - develop_deploy:
           filters:
             branches:
               only:
               - develop
 
   staging:
-    jobs: 
+    jobs:
       - staging_deploy:
           filters:
             branches:
               only:
               - stage
 
   main_workflow:
-    jobs: 
+    jobs:
       - main_deploy:
           filters:
             branches:

.eslintrc.yml

@@ -0,0 +1 @@
+20.11

.nvmrc

@@ -13,8 +13,7 @@ in response to HTTP requests.
 
 This Analytics API maintains the schema for the database that the
 [Analytics Reporter](https://github.com/18F/analytics-reporter)
-writes to.
-Thus, the Analytics API must be setup and
+writes to. Thus, the Analytics API must be setup and
 configured before the Analytics Reporter starts writing data.
 
 First, create the database:
@@ -23,6 +22,10 @@ First, create the database:
 createdb analytics-reporter
 ```
 
+````bash
+export NODE_ENV=development # developing locally
+````
+
 Once the database is created, clone the app and install the dependencies via NPM.
 The install script has a postinstall hook that will migrate
 the database.
@@ -48,6 +51,7 @@ is configured to write to the same database and run with the `--write-to-databas
 # Using the API
 
 The Analytics API exposes 3 API endpoints:
+include version in the request, ie `/v2/`
 
 - `/reports/:report_name/data`
 - `/agencies/:agency_name/reports/:reportName/data`

README.md

@@ -1,5 +1,5 @@
 #!/bin/bash
 export NEW_RELIC_APP_NAME="analytics-reporter-api"
-export NODE_ENV="test"
 export PATH="$PATH:/home/vcap/deps/0/bin"
+npm run migrate
 npm start

entrypoint.sh

@@ -0,0 +1,4 @@
+export NODE_ENV=development
+export POSTGRES_USER=postgres
+export POSTGRES_PASSWORD=123abc
+export POSTGRES_DATABASE=analytics-reporter

env.example

@@ -2,7 +2,9 @@ module.exports = {
   development: {
     client: 'postgresql',
     connection: {
-      database: 'analytics-reporter'
+      user: process.env.POSTGRES_USER || 'postgres',
+      password: process.env.POSTGRES_PASSWORD || '123abc',
+      database: process.env.POSTGRES_DATABASE || 'analytics-reporter',
     }
   },
   production: {

knexfile.js

@@ -0,0 +1,15 @@
+exports.up = function(knex) {
+  return knex.schema.createTable("analytics_data_ga4", table => {
+    table.increments("id")
+    table.string("report_name")
+    table.string("report_agency")
+    table.dateTime("date")
+    table.jsonb("data")
+    table.timestamps(true, true)
+    table.string("version")
+  })
+};
+
+exports.down = function(knex) {
+  return knex.schema.dropTable('analytics_data_ga4')
+};

migrations/20231218165411_create_analytics_data_ga4.js

@@ -0,0 +1,15 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+  return knex.schema.raw("ALTER TABLE analytics_data_ga4 ALTER COLUMN date TYPE date")
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+   return knex.schema.raw("ALTER TABLE analytics_data_ga4 ALTER COLUMN date TYPE timestamp with time zone")
+};

migrations/20240130203237_rename_date_time_to_date_ga4.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+  return knex.schema.table("analytics_data_ga4", table => {
+    table.dropColumn('version')
+  })
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+  return knex.schema.table("analytics_data_ga4", table => {
+    table.string('version')
+  })
+};