feat(filter): add filtering bike stations by hasAvailableDocks

schema.graphql

@@ -227,4 +227,5 @@ input OnlyFilterByInputBike {
   hasAvailableBikes: Boolean
   hasAvailableElectricalBikes: Boolean
   isInService: Boolean
+  hasAvailableDocks: Boolean
 }

src/datasources/__fixtures__/BikeStationsFixtures.ts

@@ -51,6 +51,18 @@ export const mockBikeStationsInfoAPIResponse: any = {
         capacity: 21,
         nearby_distance: 1000.0,
       },
+      {
+        station_id: 5,
+        name: "PG. LLUIS COMPANYS, 11 (ARC TRIOMF)",
+        physical_configuration: "ELECTRICBIKESTATION",
+        lat: 41.3911035,
+        lon: 2.1801763,
+        altitude: 7.0,
+        address: "PG. LLUIS COMPANYS, 11 (ARC TRIOMF)",
+        post_code: "08018",
+        capacity: 39,
+        nearby_distance: 1000.0,
+      },
     ],
   },
 };
@@ -120,6 +132,21 @@ export const mockBikeStationsStatusAPIResponse: any = {
         is_renting: 1,
         is_returning: 1,
       },
+      {
+        station_id: 5,
+        num_bikes_available: 37,
+        num_bikes_available_types: {
+          mechanical: 37,
+          ebike: 0,
+        },
+        num_docks_available: 0,
+        last_reported: 1605388149,
+        is_charging_station: true,
+        status: "IN_SERVICE",
+        is_installed: 1,
+        is_renting: 1,
+        is_returning: 1,
+      },
     ],
   },
 };
@@ -205,4 +232,24 @@ export const mockBikeStationsResponse: any = [
     name: "C/ RIBES, 13",
     status: "MAINTENANCE",
   },
+  {
+    available: {
+      bikes: {
+        electrical: 0,
+        mechanical: 37,
+        total: 37,
+      },
+      docks: 0,
+    },
+    capacity: 39,
+    id: "5",
+    lastUpdated: 1605388149,
+    location: {
+      altitude: 7,
+      latitude: 41.3911035,
+      longitude: 2.1801763,
+    },
+    name: "PG. LLUIS COMPANYS, 11 (ARC TRIOMF)",
+    status: "IN_SERVICE",
+  },
 ];

src/inputs/FilterByInput.ts

@@ -37,6 +37,9 @@ const FilterByInputBike = new GraphQLInputObjectType({
           isInService: {
             type: GraphQLBoolean,
           },
+          hasAvailableDocks: {
+            type: GraphQLBoolean,
+          },
         },
       }),
     },

src/queries/BikeStationsQuery.ts

@@ -27,6 +27,10 @@ const filterBikeStations = (
     return Number(station?.available?.bikes?.electrical ?? null) > 0;
   }
 
+  if (only?.hasAvailableDocks) {
+    return Number(station?.available?.docks ?? null) > 0;
+  }
+
   if (only?.isInService) {
     return station?.status === "IN_SERVICE";
   }

src/queries/__tests__/BikeStationsQuery.test.ts

@@ -80,6 +80,20 @@ describe("bikeStations Query", () => {
     expect(returnedStationWithNoElectricalBikes).toBeNull();
   });
 
+  it("Fetches list of bike stations with available docks", async () => {
+    const res = await query({
+      query: GET_BIKE_STATIONS,
+      variables: { filterBy: { only: { hasAvailableDocks: true } } },
+    });
+
+    //There is no station returned that has no docks
+    const returnedStationWithNoDocks =
+      res?.data?.bikeStations.stations.edges.find(
+        ({ node }) => node.available.docs === 0
+      ) ?? null;
+
+    expect(returnedStationWithNoDocks).toBeNull();
+  });
   it("Fetches list of bike stations that are in service ", async () => {
     const res = await query({
       query: GET_BIKE_STATIONS,

types/index.d.ts

@@ -265,4 +265,5 @@ export type OnlyFilterByInputBike = {
   hasAvailableBikes?: Maybe<Scalars['Boolean']>;
   hasAvailableElectricalBikes?: Maybe<Scalars['Boolean']>;
   isInService?: Maybe<Scalars['Boolean']>;
+  hasAvailableDocks?: Maybe<Scalars['Boolean']>;
 };