feature(opportunity-outside-range-c1-c2)

.vscode/launch.json

@@ -5,14 +5,14 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "integration-tests - test/features/leasing/named-leasing/implemented/lease-opportunity-capacity-update-test.js",
+            "name": "integration-tests - test/features/leasing/named-leasing/implemented/lease-response-test.js",
             "request": "launch",
             "runtimeArgs": [
                 "run-script",
                 "start-tests",
                 "--",
                 "--runInBand",
-                "test/features/leasing/named-leasing/implemented/lease-opportunity-capacity-update-test.js"
+                "test/features/leasing/named-leasing/implemented/lease-response-test.js"
             ],
             "runtimeExecutable": "npm",
             "skipFiles": [

packages/openactive-integration-tests/test/features/README.md

@@ -70,7 +70,7 @@ The tests for these features are fully stubbed, and are not yet implemented.
 | notifications | Opportunity attendance updates ([opportunity-attendance-updates](./notifications/opportunity-attendance-updates/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#opportunity-attendance-updates) | Allowing the broker to recieve updates for when an attendee attends an event |  |
 | payment | Payment reconciliation detail validation ([payment-reconciliation-detail-validation](./payment/payment-reconciliation-detail-validation/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#payment-reconciliation-detail-validation) | Booking with valid, invalid, and missing Payment details |  |
 | restrictions | Booking restrictions ([booking-restrictions](./restrictions/booking-restrictions/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#booking-restrictions) | Support for genderRestriction, ageRestriction and additionalAdmissionRestriction |  |
-| restrictions | validFromBeforeStartDate booking window ([booking-window](./restrictions/booking-window/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#definition-of-a-bookable-opportunity-and-offer-pair) | Duration of window before an opportunity where it is bookable | [TestOpportunityBookableWithinValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableWithinValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x1 |
+| restrictions | validFromBeforeStartDate booking window ([booking-window](./restrictions/booking-window/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#definition-of-a-bookable-opportunity-and-offer-pair) | Duration of window before an opportunity where it is bookable | [TestOpportunityBookableWithinValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableWithinValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x2, [TestOpportunityBookableOutsideValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableOutsideValidFromBeforeStartDate) x3 |
 | tax | Business-to-business Tax Calculation (TaxGross) ([business-to-business-tax-calculation-gross](./tax/business-to-business-tax-calculation-gross/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#business-to-business-tax-calculation-by-booking-system-is-optional) | Tax calculation when the customer is of type Organization (business-to-business), when the seller has taxMode TaxGross |  |
 | tax | Business-to-business Tax Calculation (TaxNet) ([business-to-business-tax-calculation-net](./tax/business-to-business-tax-calculation-net/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#business-to-business-tax-calculation-by-booking-system-is-optional) | Tax calculation when the customer is of type Organization (business-to-business), when the seller has taxMode TaxNet |  |
 | tax | Business-to-consumer Tax Calculation (TaxGross) ([business-to-consumer-tax-calculation-gross](./tax/business-to-consumer-tax-calculation-gross/README.md)) | [Optional](https://www.openactive.io/open-booking-api/EditorsDraft/#business-to-consumer-tax-calculation-by-booking-system-is-mandatory) | Tax calculation when the customer is of type Person (business-to-consumer), when the seller has taxMode TaxGross |  |

packages/openactive-integration-tests/test/features/leasing/named-leasing/implemented/lease-opportunity-capacity-update-test.js

@@ -121,6 +121,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should not take into account leased opportunities on this order
       itShouldHaveCapacity(5, c1, () => state.c1Response);
     });
 
@@ -132,6 +133,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should not take into account leased opportunities on this order
       itShouldHaveCapacity(5, c2, () => state.c2Response);
     });
 
@@ -144,6 +146,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should be idempotent
       itShouldHaveCapacity(5, c2, () => state.c2Response);
     });
   });
@@ -166,6 +169,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should take into account leases on other orders
       itShouldHaveCapacity(2, c1, () => state.c1Response);
     });
 
@@ -211,6 +215,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should only take into account leases on other orders
       itShouldHaveCapacity(2, c1, () => state.c1Response);
     });
 
@@ -222,6 +227,7 @@ FeatureHelper.describeFeature(module, {
         .successChecks()
         .validationTests();
 
+      // it should only take into account leases on other orders
       itShouldHaveCapacity(2, c2, () => state.c2Response);
     });
   });

packages/openactive-integration-tests/test/features/restrictions/booking-window/README.md

@@ -10,7 +10,7 @@ Coverage Status: **none**
 ### Test prerequisites
 Opportunities that match the following criteria must exist in the booking system (for each configured `bookableOpportunityTypesInScope`) for the configured primary Seller in order to use `useRandomOpportunities: true`. Alternatively the following `testOpportunityCriteria` values must be supported by the [test interface](https://openactive.io/test-interface/) of the booking system for `useRandomOpportunities: false`.
 
-[TestOpportunityBookableWithinValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableWithinValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x1
+[TestOpportunityBookableWithinValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableWithinValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x2, [TestOpportunityBookableOutsideValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableOutsideValidFromBeforeStartDate) x3
 
 *Note the test coverage for this feature is currently nonexistent. The test suite does not yet include non-stubbed tests for this feature.*
 
@@ -30,5 +30,6 @@ Update `default.json` within `packages/openactive-integration-tests/config/` as
 | Identifier | Name | Description | Prerequisites per Opportunity Type |
 |------------|------|-------------|---------------|
 | [opportunity-in-range-c1-c2](./implemented/opportunity-in-range-c1-c2-test.js) | Running C1 and C2 for opportunity in range should succeed | Booking an opportunity within the specified booking window | [TestOpportunityBookableWithinValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableWithinValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x1 |
+| [opportunity-outside-range-c1-c2](./implemented/opportunity-outside-range-c1-c2-test.js) | Running C1 and C2 for opportunity outside range should fail | Booking an opportunity outside the specified booking window | [TestOpportunityBookableOutsideValidFromBeforeStartDate](https://openactive.io/test-interface#TestOpportunityBookableOutsideValidFromBeforeStartDate) x3, [TestOpportunityBookable](https://openactive.io/test-interface#TestOpportunityBookable) x1 |
 
 

packages/openactive-integration-tests/test/features/restrictions/booking-window/implemented/opportunity-outside-range-c1-c2-test.js

@@ -0,0 +1,75 @@
+const chai = require('chai');
+const chakram = require('chakram');
+const { FeatureHelper } = require('../../../../helpers/feature-helper');
+const { GetMatch, C1, C2 } = require('../../../../shared-behaviours');
+const { Common } = require('../../../../shared-behaviours/common');
+
+/**
+ * @typedef {import('chakram').ChakramResponse} ChakramResponse
+ */
+
+/**
+ * @param {C1|C2} stage
+ * @param {() => ChakramResponse} responseAccessor This is wrapped in a
+ *   function because the actual response won't be available until the
+ *   asynchronous before() block has completed.
+ */
+function itShouldReturn409Conflict(stage, responseAccessor) {
+  it('should return 409', () => {
+    stage.expectResponseReceived();
+    chakram.expect(responseAccessor()).to.have.status(409);
+  });
+}
+
+FeatureHelper.describeFeature(module, {
+  testCategory: 'restrictions',
+  testFeature: 'booking-window',
+  testFeatureImplemented: true,
+  testIdentifier: 'opportunity-outside-range-c1-c2',
+  testName: 'Running C1 and C2 for opportunity outside range should fail',
+  testDescription: 'Booking an opportunity outside the specified booking window',
+  testOpportunityCriteria: 'TestOpportunityBookableOutsideValidFromBeforeStartDate',
+  controlOpportunityCriteria: 'TestOpportunityBookable',
+},
+(configuration, orderItemCriteria, featureIsImplemented, logger, state, flow) => {
+  beforeAll(async () => {
+    await state.fetchOpportunities(orderItemCriteria);
+  });
+
+  describe('Get Opportunity Feed Items', () => {
+    (new GetMatch({
+      state, flow, logger, orderItemCriteria,
+    }))
+      .beforeSetup()
+      .successChecks()
+      .validationTests();
+  });
+
+  describe('C1', () => {
+    (new C1({
+      state, flow, logger,
+    }))
+      .beforeSetup()
+      .successChecks()
+      .validationTests();
+  });
+
+  describe('C2', () => {
+    const c2 = (new C2({
+      state, flow, logger,
+    }))
+      .beforeSetup()
+      .validationTests();
+
+    itShouldReturn409Conflict(c2, () => state.c2Response);
+    Common.itForOrderItemByControl(orderItemCriteria, state, c2, () => state.c2Response.body,
+      'should include an OpportunityOfferPairNotBookableError',
+      (feedOrderItem, responseOrderItem, responseOrderItemErrorTypes) => {
+        chai.expect(responseOrderItemErrorTypes).to.include('OpportunityOfferPairNotBookableError');
+      },
+      'should not include an OpportunityOfferPairNotBookableError',
+      (feedOrderItem, responseOrderItem, responseOrderItemErrorTypes) => {
+        chai.expect(responseOrderItemErrorTypes).not.to.include('OpportunityOfferPairNotBookableError');
+      });
+  });
+});

packages/test-interface-criteria/built-types/criteria/TestOpportunityBookableWithinValidFromBeforeStartDate.d.ts

@@ -1 +1,2 @@
+export type OfferConstraint = (offer: import("../types/Offer").Offer, opportunity: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options) => boolean;
 export const TestOpportunityBookableWithinValidFromBeforeStartDate: import("../types/Criteria").Criteria;

packages/test-interface-criteria/built-types/criteria/criteriaUtils.d.ts

@@ -61,3 +61,7 @@ export function mustBeWithinBookingWindow(offer: import("../types/Offer").Offer,
  * @returns {boolean}
  */
 export function hasCapacityLimitOfOne(opportunity: Opportunity): boolean;
+/**
+ * @type {OpportunityConstraint}
+ */
+export function remainingCapacityMustBeAtLeastTwo(opportunity: import("../types/Opportunity").Opportunity): boolean;

packages/test-interface-criteria/built-types/criteria/internal/InternalTestOpportunityBookable.d.ts

@@ -1,4 +1,3 @@
-export type OpportunityConstraint = (opportunity: import("../../types/Opportunity").Opportunity, options?: import("../../types/Options").Options) => boolean;
 export type OfferConstraint = (offer: import("../../types/Offer").Offer, opportunity: import("../../types/Opportunity").Opportunity, options?: import("../../types/Options").Options) => boolean;
 /**
  * Internal criteria which almost implements https://openactive.io/test-interface#TestOpportunityBookable

packages/test-interface-criteria/src/criteria/TestOpportunityBookableOutsideValidFromBeforeStartDate.js

@@ -1,7 +1,5 @@
-const moment = require('moment');
-
-const { TestOpportunityBookable } = require('./TestOpportunityBookable');
-const { createCriteria } = require('./criteriaUtils');
+const { InternalCriteriaFutureScheduledOpportunity } = require('./internal/InternalCriteriaFutureScheduledOpportunity');
+const { remainingCapacityMustBeAtLeastTwo, createCriteria, mustBeWithinBookingWindow } = require('./criteriaUtils');
 
 /**
  * @typedef {import('../types/Criteria').OfferConstraint} OfferConstraint
@@ -10,25 +8,28 @@ const { createCriteria } = require('./criteriaUtils');
 /**
  * @type {OfferConstraint}
  */
-function outsideValidFromBeforeStartDate(offer, opportunity, options) {
-  return (Array.isArray(offer.availableChannel) && offer.availableChannel.includes('https://openactive.io/OpenBookingPrepayment'))
-    && offer.advanceBooking !== 'https://openactive.io/Unavailable'
-    && (offer.validFromBeforeStartDate && moment(opportunity.startDate).subtract(moment.duration(offer.validFromBeforeStartDate)).isAfter(options.harvestStartTime));
+function mustBeOutsideBookingWindow(offer, opportunity, options) {
+  return offer.validFromBeforeStartDate && !mustBeWithinBookingWindow(offer, opportunity, options);
 }
 
 /**
  * Implements https://openactive.io/test-interface#TestOpportunityBookableOutsideValidFromBeforeStartDate
  */
 const TestOpportunityBookableOutsideValidFromBeforeStartDate = createCriteria({
   name: 'TestOpportunityBookableOutsideValidFromBeforeStartDate',
-  opportunityConstraints: [],
+  opportunityConstraints: [
+    [
+      'Remaining capacity must be at least two',
+      remainingCapacityMustBeAtLeastTwo,
+    ],
+  ],
   offerConstraints: [
     [
-      'Outside ValidFromBeforeStartDate',
-      outsideValidFromBeforeStartDate,
+      'Must be outside booking window',
+      mustBeOutsideBookingWindow,
     ],
   ],
-  includeConstraintsFromCriteria: TestOpportunityBookable,
+  includeConstraintsFromCriteria: InternalCriteriaFutureScheduledOpportunity,
 });
 
 module.exports = {

packages/test-interface-criteria/src/criteria/TestOpportunityBookableWithinValidFromBeforeStartDate.js

@@ -1,13 +1,24 @@
 const { InternalTestOpportunityBookable } = require('./internal/InternalTestOpportunityBookable');
 const { createCriteria, mustBeWithinBookingWindow } = require('./criteriaUtils');
 
+/**
+ * @typedef {import('../types/Criteria').OfferConstraint} OfferConstraint
+ */
+
+/**
+ * @type {OfferConstraint}
+ */
+function mustHaveBookingWindowAndBeWithinIt(offer, opportunity, options) {
+  return offer.validFromBeforeStartDate && mustBeWithinBookingWindow(offer, opportunity, options);
+}
+
 const TestOpportunityBookableWithinValidFromBeforeStartDate = createCriteria({
   name: 'TestOpportunityBookableWithinValidFromBeforeStartDate',
   opportunityConstraints: [],
   offerConstraints: [
     [
       'Must be within booking window',
-      mustBeWithinBookingWindow,
+      mustHaveBookingWindowAndBeWithinIt,
     ],
   ],
   includeConstraintsFromCriteria: InternalTestOpportunityBookable,

packages/test-interface-criteria/src/criteria/criteriaUtils.js

@@ -50,7 +50,6 @@ function getType(opportunity) {
   return opportunity['@type'] || opportunity.type;
 }
 
-
 /**
  * @param {Opportunity} opportunity
  * @returns {boolean}
@@ -75,7 +74,7 @@ function getRemainingCapacity(opportunity) {
  */
 function mustBeWithinBookingWindow(offer, opportunity, options) {
   if (!offer || !offer.validFromBeforeStartDate) {
-    return false;
+    return null; // Required for validation step
   }
 
   const start = moment(opportunity.startDate);
@@ -85,11 +84,21 @@ function mustBeWithinBookingWindow(offer, opportunity, options) {
   return valid;
 }
 
+/**
+ * @type {OpportunityConstraint}
+ */
+function remainingCapacityMustBeAtLeastTwo(opportunity) {
+  // A capacity of at least 2 is needed for cases other than IndividualFacilityUse because the multiple OrderItem tests use 2 of the same item (via the opportunityReuseKey).
+  // The opportunityReuseKey is not used for IndividualFacilityUse, which is limited to a maximumUses of 1 by the specification.
+  return getRemainingCapacity(opportunity) > (hasCapacityLimitOfOne(opportunity) ? 0 : 1);
+}
+
 module.exports = {
   createCriteria,
   getId,
   getType,
   getRemainingCapacity,
   mustBeWithinBookingWindow,
   hasCapacityLimitOfOne,
+  remainingCapacityMustBeAtLeastTwo,
 };

packages/test-interface-criteria/src/criteria/internal/InternalTestOpportunityBookable.js

@@ -1,22 +1,12 @@
 const moment = require('moment');
 
 const { InternalCriteriaFutureScheduledOpportunity } = require('../internal/InternalCriteriaFutureScheduledOpportunity');
-const { getRemainingCapacity, createCriteria, hasCapacityLimitOfOne } = require('../criteriaUtils');
+const { remainingCapacityMustBeAtLeastTwo, createCriteria } = require('../criteriaUtils');
 
 /**
- * @typedef {import('../../types/Criteria').OpportunityConstraint} OpportunityConstraint
  * @typedef {import('../../types/Criteria').OfferConstraint} OfferConstraint
  */
 
-/**
- * @type {OpportunityConstraint}
- */
-function remainingCapacityMustBeAtLeastTwo(opportunity) {
-  // A capacity of at least 2 is needed for cases other than IndividualFacilityUse because the multiple OrderItem tests use 2 of the same item (via the opportunityReuseKey).
-  // The opportunityReuseKey is not used for IndividualFacilityUse, which is limited to a maximumUses of 1 by the specification.
-  return getRemainingCapacity(opportunity) > (hasCapacityLimitOfOne(opportunity) ? 0 : 1);
-}
-
 /**
  * @type {OfferConstraint}
  */