test auto rollback

.github/workflows/deploy.yml

@@ -0,0 +1,60 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - qa
+      - production
+      - qa2
+
+# Global environment variable based on the branch name
+env:
+  ENV_TAG: ${{ github.ref_name }}
+  ECR_REPOSITORY: discovery-api
+
+jobs:
+  tests:
+    name: Run Tests
+    uses: ./.github/workflows/test.yml
+
+  deploy:
+    permissions:
+      id-token: write
+      contents: read
+    runs-on: ubuntu-latest
+    needs: tests
+    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: Log in to ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v1
+
+      - name: Back up previous image for rollback
+        run: |
+          MANIFEST=$(aws ecr batch-get-image --repository-name ${{ env.ECR_REPOSITORY }} --image-ids imageTag="${{ env.ENV_TAG }}-latest" --output json | jq --raw-output --join-output '.images[0].imageManifest')
+          PREVIOUS_MANIFEST=$(aws ecr batch-get-image --repository-name ${{ env.ECR_REPOSITORY }} --image-ids imageTag="${{ env.ENV_TAG }}-previous" --output json | jq --raw-output --join-output '.images[0].imageManifest')
+          if [ "$MANIFEST" != "$PREVIOUS_MANIFEST" ]; then 
+            aws ecr put-image --repository-name ${{ env.ECR_REPOSITORY }} --image-tag "${{ env.ENV_TAG }}-previous" --image-manifest "$MANIFEST"
+          fi
+
+      - name: Build, tag, and push image to Amazon ECR
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          IMAGE_TAG: ${{ github.sha }}
+        run: |
+          docker build -t $ECR_REGISTRY/${{ env.ECR_REPOSITORY }}:$IMAGE_TAG .
+          docker push $ECR_REGISTRY/${{ env.ECR_REPOSITORY }}:$IMAGE_TAG
+          docker tag $ECR_REGISTRY/${{ env.ECR_REPOSITORY }}:$IMAGE_TAG $ECR_REGISTRY/${{ env.ECR_REPOSITORY }}:${{ env.ENV_TAG }}-latest
+          docker push $ECR_REGISTRY/${{ env.ECR_REPOSITORY }}:${{ env.ENV_TAG }}-latest
+
+      - name: Force ECS Update
+        run: |
+          aws ecs update-service --cluster discovery-api-${{ env.ENV_TAG }} --service discovery-api-${{ env.ENV_TAG }} --force-new-deployment

.github/workflows/integration-tests.yml

@@ -1,25 +1,44 @@
+name: Run Smoke Tests
+
+on:
+  workflow_run:
+    workflows: ["Deploy"]
+    types: [completed]
+    branches: [production, qa, qa2]
+
+permissions:
+  id-token: write
+  contents: read
+
+env:
+  ENV: ${{ github.event.workflow_run.head_branch }}
+
 jobs:
-  integration-test-qa:
+  integration-test:
     permissions:
       id-token: write
       contents: read
     runs-on: ubuntu-latest
-    needs: tests
-    if: github.ref == 'refs/heads/qa2'
-    steps: 
+    steps:
       - 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
-      - uses: actions/checkout@v4
+      - name: Wait for stable service
+        uses: nick-fields/retry@v3
+        with:
+          max_attempts: 3
+          timeout_minutes: 10
+          command: aws ecs wait services-stable --cluster discovery-api-${{env.ENV}} --services discovery-api-${{env.ENV}}
+      - uses: actions/checkout@v3
       - name: Set Node version
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v3
         with:
-          node-version-file: '.nvmrc'
-      - name: Install dependencies
-        run: npm ci
-      - name: Start service
-        run: ENV=qa npm start &
-      - name: Run tests
-        run: node test/integration/delivery-locations-by-barcode.test.js
+          node-version-file: ".nvmrc"
+      - name: npm install
+        run: npm i
+      - name: Run integration tests
+        env:
+          ENV: "qa"
+        run: node test/integration/delivery-locations-by-barcode.test.js

.github/workflows/rollback-qa2.yml

@@ -1,7 +1,12 @@
 name: Rollback qa2
 
-on:
-  workflow_dispatch:
+on: 
+  workflow_run:
+    workflows: ["Run Smoke Test"]
+    types: [completed]
+
+env:
+  ENV: ${{ github.event.workflow_run.head_branch }}
 
 jobs:
   # Rollback job in case of failure (Revert qa to the previous task definition)
@@ -11,6 +16,7 @@ jobs:
         contents: read
     name: Rollback to Previous Version
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' && env.ENV == 'qa2'}}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Unit Tests
+
+on: 
+  workflow_call:
+  push:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    permissions:
+        id-token: write
+        contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - name: npm install
+        run: npm ci
+      - name: Unit Tests
+        run: npm test

config/production.env

@@ -1,5 +1,5 @@
 ENCRYPTED_ELASTICSEARCH_URI=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAJYwgZMGCSqGSIb3DQEHBqCBhTCBggIBADB9BgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDFWw8ECX9Pz81z0kvAIBEIBQGec9PCpwuvEgLH6imhqP6tx1fj8Vlf2ZipnUy06jzmpE262Qvk9LPAq7sIYPVkTCZctwilwcU9oC6yxasVoUlK87la77v03CeZsPIDwciFY=
-ENCRYPTED_RESOURCES_INDEX=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAHcwdQYJKoZIhvcNAQcGoGgwZgIBADBhBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDLHxxMobbmmkVc76dQIBEIA0aZV7enzAKvaDMt7lJik1Ps8J6wikj4dJTL6YzjIlpRh8Dsl7tYgpEgsTNVqA7JRhErUT9w==
+ENCRYPTED_RESOURCES_INDEX=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAHcwdQYJKoZIhvcNAQcGoGgwZgIBADBhBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDAk2mOM+zTrPU2rOagIBEIA0E3OuraTI5i3rqAiNrAj4RKV/c6DqotQ5nqSP8TzKk0qZYlHz+1jua11ZtKHIJ9LhszaE4Q==
 ENCRYPTED_ELASTICSEARCH_API_KEY=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAJ4wgZsGCSqGSIb3DQEHBqCBjTCBigIBADCBhAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAyPOPaQCBbvKQhJoPQCARCAV2TlWlRh+xKnCegpprEQgfldZGcVW48RND0LVd/pQpVTJnRTtbCpP7damT7k8ziJVdWZ3jsfs5fw5YnKc/EIQ1M//DRUzOJL98ir5LTTxE7QhflKDtUY+Q==
 
 ENCRYPTED_SCSB_URL=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAHwwegYJKoZIhvcNAQcGoG0wawIBADBmBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDKPFC8wFkVM5CyT6VQIBEIA5m4eLBkpChRA//ZNEWsRqIDGZmevb/thzI03a0NiAW6VfybSAYpFthh+bj/yAk1VEEBF6r1T4A2GP
@@ -10,7 +10,7 @@ NYPL_OAUTH_URL=https://isso.nypl.org/
 ENCRYPTED_NYPL_OAUTH_ID=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGswaQYJKoZIhvcNAQcGoFwwWgIBADBVBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDMLKVUQA58B6vprNcAIBEIAoaz0lI9EL2M9NyTuEwT8JDmPBt6aXfMiFs027DEuwsCN0wS0qWeFL1g==
 ENCRYPTED_NYPL_OAUTH_SECRET=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAIcwgYQGCSqGSIb3DQEHBqB3MHUCAQAwcAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAyWz91LOP2YP5fg0q0CARCAQ9inO9SV1M8R0Pkkx84r7UdwlU1FxfXvIjk/z6Qs81KBAVELhby2iD5LawQyDrR9tjhuMbotS6QnydwwMR/p8+qJXHI=
 
-NYPL_CORE_VERSION=v2.35
+NYPL_CORE_VERSION=v2.39
 
 LOG_LEVEL=info
 FEATURES=on-site-edd

config/qa.env

@@ -12,7 +12,7 @@ NYPL_OAUTH_URL=https://isso.nypl.org/
 ENCRYPTED_NYPL_OAUTH_ID=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGswaQYJKoZIhvcNAQcGoFwwWgIBADBVBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDMLKVUQA58B6vprNcAIBEIAoaz0lI9EL2M9NyTuEwT8JDmPBt6aXfMiFs027DEuwsCN0wS0qWeFL1g==
 ENCRYPTED_NYPL_OAUTH_SECRET=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAIcwgYQGCSqGSIb3DQEHBqB3MHUCAQAwcAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAyWz91LOP2YP5fg0q0CARCAQ9inO9SV1M8R0Pkkx84r7UdwlU1FxfXvIjk/z6Qs81KBAVELhby2iD5LawQyDrR9tjhuMbotS6QnydwwMR/p8+qJXHI=
 
-NYPL_CORE_VERSION=v2.35
+NYPL_CORE_VERSION=v2.39
 
 LOG_LEVEL=debug
 FEATURES=on-site-edd

config/test.env

@@ -10,7 +10,7 @@ NYPL_OAUTH_URL=http://oauth.example.com
 NYPL_OAUTH_ID=encrypted-nypl-oauth-id
 NYPL_OAUTH_SECRET=encrypted-nypl-oauth-id
 
-NYPL_CORE_VERSION=v2.37
+NYPL_CORE_VERSION=v2.39
 
 LOG_LEVEL=error
 FEATURES=on-site-edd

lib/available_delivery_location_types.js

@@ -8,7 +8,6 @@ class AvailableDeliveryLocationTypes {
     if (!patronID) return null
 
     const patronType = await this._getPatronTypeOf(patronID)
-
     if (this._isUnfamiliarPatronType(patronType)) {
       return null
     }

lib/contributors.js

@@ -100,21 +100,33 @@ module.exports = function (app, _private = null) {
 }
 
 /**
- * Builds an aggregation query that checks the resource index for counts on the contributorRoleLiteral field for a list of contributors.
+ * Builds an aggregation query that checks the resource index for counts on the browseableContributorRole_packed field for a list of contributors.
  */
 const buildElasticRoleCountQuery = function (contributorList) {
   return {
     size: 0,
     query: {
-      terms: {
-        contributorRoleLiteral: contributorList
+      bool: {
+        should: [
+          {
+            terms: {
+              'creatorLiteral.keywordLowercased': contributorList
+            }
+          },
+          {
+            terms: {
+              'contributorLiteral.keywordLowercased': contributorList
+            }
+          }
+        ],
+        minimum_should_match: 1
       }
     },
     aggs: {
       contributor_role: {
         terms: {
           script: {
-            source: 'def results = []; for (val in doc["contributorRoleLiteral"]) { int pos = val.indexOf("||"); if (pos != -1) { String name = val.substring(0, pos); if (params.targets.contains(name)) { results.add(val); } } } return results;',
+            source: 'def results = []; for (val in doc["browseableContributorRole_packed"]) { int pos = val.indexOf("||"); if (pos != -1) { String name = val.substring(0, pos); if (params.targets.contains(name)) { results.add(val); } } } return results;',
             params: {
               targets: contributorList
             }

lib/display-field-unpacker.js

@@ -0,0 +1,25 @@
+const parseValueAndLabel = (delimitedString) => {
+  if (!delimitedString.includes('||')) {
+    return { value: delimitedString, display: null }
+  }
+  const [value, display] = delimitedString.split('||')
+  return { value, display }
+}
+
+module.exports = (elasticSearchResponse) => {
+  elasticSearchResponse.hits.hits.forEach((bib) => {
+    // Contributors and creators are packed like so <name>||<display label> where <display label>
+    // can have prefix, title, and roles. We'd like to unpack them in a friendly format for the frontend
+    // to display the full label and use the isolated name for link-building
+    Object.entries(bib._source).forEach(([key, value]) => {
+      if (key.endsWith('_displayPacked')) {
+        const fieldName = key.replace('_displayPacked', '')
+        bib._source[fieldName + 'Display'] = value.map((packedValue) => parseValueAndLabel(packedValue))
+        delete bib._source[key]
+      }
+    })
+
+    return bib
+  })
+  return elasticSearchResponse
+}

lib/elasticsearch/config.js

@@ -90,7 +90,7 @@ const FILTER_CONFIG = {
   mediaType: { operator: 'match', field: ['mediaType.id', 'mediaType.label'], repeatable: true },
   carrierType: { operator: 'match', field: ['carrierType.id', 'carrierType.label'], repeatable: true },
   publisher: { operator: 'match', field: ['publisherLiteral.raw'], repeatable: true },
-  contributorLiteral: { operator: 'match', field: ['contributorLiteral.keywordLowercased', 'parallelContributor.raw', 'creatorLiteral.keywordLowercased', 'parallelCreatorLiteral.raw'], repeatable: true },
+  contributorLiteral: { operator: 'match', field: ['contributorLiteral.keywordLowercased', 'parallelContributorLiteral.raw', 'creatorLiteral.keywordLowercased', 'parallelCreatorLiteral.raw'], repeatable: true },
   creatorLiteral: { operator: 'match', field: ['creatorLiteral.raw', 'parallelCreatorLiteral.raw'], repeatable: true },
   issuance: { operator: 'match', field: ['issuance.id', 'issuance.label'], repeatable: true },
   createdYear: { operator: 'match', field: ['createdYear'], repeatable: true },

lib/elasticsearch/elastic-query-builder.js

@@ -183,7 +183,7 @@ class ElasticQueryBuilder {
    * Concat contributor + role if role param is provided
    */
   applyContributorRole () {
-    this.query.addMust(termMatch('contributorRoleLiteral', this.request.params.filters.contributorLiteral + '||' + this.request.params.role))
+    this.query.addMust(termMatch('browseableContributorRole_packed', this.request.params.filters.contributorLiteral + '||' + this.request.params.role))
   }
 
   /**

lib/jsonld_serializers.js

@@ -301,12 +301,14 @@ ResourceSerializer.getFormattedFormat = function (formatId) {
 
 ResourceSerializer.formatCollection = function (collectionId) {
   const prefLabel = nyplCore.collections()[`nyplCollection:${collectionId}`]?.label
+  const locationsPath = nyplCore.collections()[`nyplCollection:${collectionId}`]?.locationsPath
   const buildingLocationLabel = buildingLocations.find((loc) => loc.value === collectionId.slice(0, 2))?.label
   if (!prefLabel) return null
   return {
     '@id': collectionId,
     prefLabel,
-    buildingLocationLabel
+    buildingLocationLabel,
+    locationsPath
   }
 }
 
@@ -374,10 +376,15 @@ class ItemResourceSerializer extends JsonLdItemSerializer {
         })
     }
 
+    if (this.body.holdingLocation) {
+      stmts.holdingLocation = ItemResourceSerializer.getFormattedHoldingLocation(this.body.holdingLocation)
+    }
+
     // Override default serialization of item.electronicLocator statements (full digital surrogates):
     if (this.body.electronicLocator) {
       stmts.electronicLocator = this.body.electronicLocator.map((link) => ResourceSerializer.formatElectronicResourceBlankNode(link, 'nypl:ElectronicLocation'))
     }
+
     return stmts
   }
 
@@ -386,6 +393,19 @@ class ItemResourceSerializer extends JsonLdItemSerializer {
     return (new ItemResourceSerializer(resp, options)).format()
   }
 
+  static getFormattedHoldingLocation (location) {
+    const loc = Array.isArray(location) ? location[0] : null
+    if (!loc) return []
+    const locationId = loc['@id']?.split(':')[1]
+    const sierraLocations = nyplCore.sierraLocations()
+    const collectionAccessType = sierraLocations?.[locationId]?.collectionAccessType
+    return [{
+      '@id': loc['@id'],
+      prefLabel: loc?.prefLabel,
+      collectionAccessType
+    }]
+  }
+
   // Given an item, returns item with an added `identifier`
   // of form 'urn:[sourceIdentifierPrefix]:[sourceIdentifier]'
   // e.g.

lib/models/Item.js

@@ -114,7 +114,6 @@ Item.withDeliveryLocationsByBarcode = async function (item, scholarRoom) {
   const model = new Item(item)
   item.eddRequestable = !!model.eddRequestable
   const filteredDeliveryLocationsWithScholarRoom = locationUtils.filterLocations(model.deliveryLocation, scholarRoom)
-
   item.deliveryLocation = locationUtils.formatLocations(filteredDeliveryLocationsWithScholarRoom)
   return item
 }

lib/models/Location.js

@@ -24,18 +24,7 @@ class Location {
       case 'm2-customer-code':
         return this.deliveryLocationsByM2CustomerCode
       default:
-        return this.deliveryLocationByHoldingLocation
-    }
-  }
-
-  get deliveryLocationByHoldingLocation () {
-    if (this.nyplCoreLocation?.sierraDeliveryLocations?.length) {
-      // It's mapped, but the sierraDeliveryLocation entities only have `code` and `label`
-      // Do a second lookup to populate `deliveryLocationTypes`
-      return this.nyplCoreLocation.sierraDeliveryLocations.map((deliveryLocation) => {
-        deliveryLocation.deliveryLocationTypes = this.nyplCoreLocation.deliveryLocationTypes
-        return deliveryLocation
-      })
+        return this.nyplCoreLocation?.sierraDeliveryLocations
     }
   }
 

lib/resources.js

@@ -48,6 +48,10 @@ const SORT_FIELDS = {
     initialDirection: 'asc',
     field: 'creator_sort'
   },
+  callnumber: {
+    initialDirection: 'asc',
+    field: 'shelfMark.keywordLowercased'
+  },
   relevance: {}
 }
 
@@ -334,7 +338,6 @@ module.exports = function (app, _private = null) {
         // The resolved values of Promise.all are strictly ordered based on original array of promises
         const items = resp[0]
         const scholarRoom = resp[1]
-
         // Use HTC API and nypl-core mappings to ammend ES response with deliveryLocations:
         return Promise.all(items.map(async (item) => Item.withDeliveryLocationsByBarcode(item, scholarRoom)))
           .catch((e) => {