feat: add hint function environment variable (#566)

* chore: add missing hint repository workflow * fix: hint repository tests * feat: add hint function url * chore: update workflows to support hint function url env var
VGVentures · Jun 12, 2024 · 1a7bf1c · 1a7bf1c
1 parent 897cfd3
commit 1a7bf1c
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 4 deletions.
diff --git a/.github/workflows/api_hint_repository.yaml b/.github/workflows/api_hint_repository.yaml
@@ -0,0 +1,20 @@
+name: api_hint_repository
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    paths:
+      - "api/packages/hint_repository/**"
+      - ".github/workflows/api_hint_repository.yaml"
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      dart_sdk: stable
+      working_directory: api/packages/hint_repository
diff --git a/.github/workflows/deploy_api_dev.yaml b/.github/workflows/deploy_api_dev.yaml
@@ -16,6 +16,7 @@ env:
   GAME_URL: "*"
   INITIALS_BLACKLIST_ID: T1ilfCwjDpLS7iaFzenA
   FB_STORAGE_BUCKET: io-crossword-dev.appspot.com
+  HINT_FUNCTION_URL: gethintkit-sea6y22h5q-uc.a.run.app
 
 jobs:
   deploy:
@@ -61,6 +62,7 @@ jobs:
             GAME_URL=${{ env.GAME_URL }}
             INITIALS_BLACKLIST_ID=${{ env.INITIALS_BLACKLIST_ID }}
             FB_STORAGE_BUCKET=${{ env.FB_STORAGE_BUCKET }}
+            HINT_FUNCTION_URL=${{ env.HINT_FUNCTION_URL }}
 
       - name: Show Output
         run: echo ${{ steps.deploy.outputs.url }}

diff --git a/.github/workflows/deploy_api_prod.yaml b/.github/workflows/deploy_api_prod.yaml
@@ -9,6 +9,7 @@ env:
   GAME_URL: https://prod-9961b3776301c37db86d9038f.web.app
   INITIALS_BLACKLIST_ID: CRORRJZBdf0rLLkHDr9j
   FB_STORAGE_BUCKET: io-crossword.appspot.com
+  HINT_FUNCTION_URL: gethintkit-u3emptgwka-uc.a.run.app
 
 jobs:
   deploy:
@@ -54,6 +55,7 @@ jobs:
             GAME_URL=${{ env.GAME_URL }}
             INITIALS_BLACKLIST_ID=${{ env.INITIALS_BLACKLIST_ID }}
             FB_STORAGE_BUCKET=${{ env.FB_STORAGE_BUCKET }}
+            HINT_FUNCTION_URL=${{ env.HINT_FUNCTION_URL }}
 
       - name: Show Output
         run: echo ${{ steps.deploy.outputs.url }}

diff --git a/.github/workflows/deploy_api_staging.yaml b/.github/workflows/deploy_api_staging.yaml
@@ -9,6 +9,7 @@ env:
   GAME_URL: https://stg-e7b2896c65fabc0480edc6c0e.web.app
   INITIALS_BLACKLIST_ID: T1ilfCwjDpLS7iaFzenA
   FB_STORAGE_BUCKET: io-crossword-dev.appspot.com
+  HINT_FUNCTION_URL: gethintkit-sea6y22h5q-uc.a.run.app
 
 jobs:
   deploy:
@@ -54,6 +55,7 @@ jobs:
             GAME_URL=${{ env.GAME_URL }}
             INITIALS_BLACKLIST_ID=${{ env.INITIALS_BLACKLIST_ID }}
             FB_STORAGE_BUCKET=${{ env.FB_STORAGE_BUCKET }}
+            HINT_FUNCTION_URL=${{ env.HINT_FUNCTION_URL }}
 
       - name: Show Output
         run: echo ${{ steps.deploy.outputs.url }}

diff --git a/api/main.dart b/api/main.dart
@@ -25,6 +25,7 @@ Future<void> init(InternetAddress ip, int port) async {
   crosswordRepository = CrosswordRepository(dbClient: dbClient);
   hintRepository = HintRepository(
     dbClient: dbClient,
+    getHintUrl: _getHintUrl,
   );
   boardRenderer = const BoardRenderer();
 
@@ -86,4 +87,12 @@ String get _gameUrl {
   return value;
 }
 
+String get _getHintUrl {
+  final value = Platform.environment['HINT_FUNCTION_URL'];
+  if (value == null) {
+    throw ArgumentError('HINT_FUNCTION_URL is required to run the API');
+  }
+  return value;
+}
+
 String get projectId => _appId;
diff --git a/api/packages/hint_repository/lib/src/hint_repository.dart b/api/packages/hint_repository/lib/src/hint_repository.dart
@@ -13,11 +13,14 @@ class HintRepository {
   /// {@macro hint_repository}
   HintRepository({
     required DbClient dbClient,
+    required String getHintUrl,
     Dio? httpClient,
   })  : _dbClient = dbClient,
+        _getHintUrl = getHintUrl,
         _httpClient = httpClient ?? Dio();
 
   final DbClient _dbClient;
+  final String _getHintUrl;
   final Dio _httpClient;
 
   static const _answersCollection = 'answers';
@@ -70,7 +73,7 @@ class HintRepository {
     required String userToken,
   }) async {
     try {
-      final url = Uri.https('gethintkit-sea6y22h5q-uc.a.run.app');
+      final url = Uri.https(_getHintUrl);
       final body = {
         'data': {
           'word': wordAnswer,

diff --git a/api/packages/hint_repository/test/src/hint_repository_test.dart b/api/packages/hint_repository/test/src/hint_repository_test.dart
@@ -26,6 +26,7 @@ void main() {
       httpClient = _MockHttpClient();
       hintRepository = HintRepository(
         dbClient: dbClient,
+        getHintUrl: 'example.com',
         httpClient: httpClient,
       );
     });
@@ -34,6 +35,7 @@ void main() {
       expect(
         HintRepository(
           dbClient: dbClient,
+          getHintUrl: 'example.com',
         ),
         isNotNull,
       );
@@ -218,7 +220,7 @@ void main() {
 
     group('getPreviousHints', () {
       test('returns an empty list when no hints are found', () async {
-        when(() => dbClient.getById('answers2/wordId/hints', 'userId'))
+        when(() => dbClient.getById('answers/wordId/hints', 'userId'))
             .thenAnswer((_) async => null);
 
         final hints = await hintRepository.getPreviousHints(
@@ -230,7 +232,7 @@ void main() {
       });
 
       test('returns a list of hints', () async {
-        when(() => dbClient.getById('answers2/wordId/hints', 'userId'))
+        when(() => dbClient.getById('answers/wordId/hints', 'userId'))
             .thenAnswer(
           (_) async => DbEntityRecord(
             id: 'userId',
@@ -239,6 +241,7 @@ void main() {
                 {
                   'question': 'question',
                   'response': 'yes',
+                  'readableResponse': 'Yes, that is correct!',
                 },
               ],
             },
@@ -285,7 +288,7 @@ void main() {
 
         verify(
           () => dbClient.set(
-            'answers2/wordId/hints',
+            'answers/wordId/hints',
             DbEntityRecord(
               id: 'userId',
               data: const {

diff --git a/scripts/start_local_api.sh b/scripts/start_local_api.sh
@@ -5,6 +5,7 @@ export GAME_URL=http://localhost:24514
 export USE_EMULATOR=false
 export INITIALS_BLACKLIST_ID=T1ilfCwjDpLS7iaFzenA
 export FB_STORAGE_BUCKET=io-crossword-dev.appspot.com
+export HINT_FUNCTION_URL=gethintkit-sea6y22h5q-uc.a.run.app
 
 echo ' ######################## '
 echo ' ## Starting dart frog ## '