PR feedback

mongodb · Nov 2, 2023 · c2137b7 · c2137b7
1 parent e8c1467
commit c2137b7
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/config/default.json b/config/default.json
@@ -31,7 +31,6 @@
   "gatsbyBaseUrl": "GATSBY_BASE_URL",
   "previewBuildEnabled": "false",
   "featureFlagUpdatePages": "false",
-  "featureFlagMonorepoPath": "false",
   "featureFlagSearchUI": "false",
   "gatsbyUseChatbot": "false",
   "parallel": {

diff --git a/config/test.json b/config/test.json
@@ -13,7 +13,6 @@
   "fastlyDochubMap": "devfslydochubmap",
   "entitlementCollection": "entitlements",
   "docsetsCollection": "docsets",
-  "featureFlagMonorepoPath": "true",
   "MONGO_TIMEOUT_S": 1,
   "JOB_TIMEOUT_S": 10,
   "RETRY_TIMEOUT_MS": 10,

diff --git a/src/monorepo/types/aggregation-types.ts b/src/monorepo/types/aggregation-types.ts
@@ -0,0 +1,6 @@
+// Types to narrow matchCondition arguments for Docset aggregations
+type DirectoriesKey = 'snooty_toml';
+type RepoBranchesKey = 'project' | 'branches' | 'repoName' | `directories.${DirectoriesKey}`;
+
+export type MatchCondition = { [key in RepoBranchesKey]+?: string };
+export type Projection = { [key in RepoBranchesKey]+?: number };
diff --git a/src/repositories/docsetsRepository.ts b/src/repositories/docsetsRepository.ts
@@ -2,14 +2,15 @@ import { Db } from 'mongodb';
 import { BaseRepository } from './baseRepository';
 import { ILogger } from '../services/logger';
 import { IConfig } from 'config';
+import { MatchCondition, Projection } from '../monorepo/types/aggregation-types';
 
 const docsetsCollectionName = process.env.DOCSETS_COL_NAME || 'docsets';
 export class DocsetsRepository extends BaseRepository {
   constructor(db: Db, config: IConfig, logger: ILogger) {
     super(config, logger, 'DocsetsRepository', db.collection(docsetsCollectionName));
   }
 
-  static getAggregationPipeline(matchConditions: { [k: string]: string }, projection?: { [k: string]: number }) {
+  static getAggregationPipeline(matchConditions: MatchCondition, projection?: Projection) {
     const DEFAULT_PROJECTIONS = {
       _id: 0,
       repos: 0,

diff --git a/tests/data/data.ts b/tests/data/data.ts
@@ -448,8 +448,4 @@ export class TestDataProvider {
     }
     return retVal;
   }
-
-  static getAggregationPipeline(matchConditions: { [k: string]: string }, projection?: { [k: string]: number }) {
-    return DocsetsRepository.getAggregationPipeline(matchConditions, projection);
-  }
 }
diff --git a/tests/unit/repositories/docsetsRepository.test.ts b/tests/unit/repositories/docsetsRepository.test.ts
@@ -1,5 +1,4 @@
 import { DBRepositoryHelper } from '../../utils/repositoryHelper';
-import { TestDataProvider } from '../../data/data';
 import { DocsetsRepository } from '../../../src/repositories/docsetsRepository';
 
 describe('Docsets Repository Tests', () => {
@@ -16,7 +15,7 @@ describe('Docsets Repository Tests', () => {
 
   describe('Docsets Repository getRepoBranchesByRepoName Tests', () => {
     test('getRepoBranchesByRepoName returns failure as result is undefined', async () => {
-      const testPipeline = TestDataProvider.getAggregationPipeline({ repoName: 'test_repo', project: 'test_project' });
+      const testPipeline = DocsetsRepository.getAggregationPipeline({ repoName: 'test_repo', project: 'test_project' });
       dbRepoHelper.collection.aggregate.mockReturnValueOnce({
         toArray: () => [],
       });
@@ -28,7 +27,7 @@ describe('Docsets Repository Tests', () => {
     });
 
     test('getRepoBranchesByRepoName is successfull', async () => {
-      const testPipeline = TestDataProvider.getAggregationPipeline({ repoName: 'test_repo', project: 'test_project' });
+      const testPipeline = DocsetsRepository.getAggregationPipeline({ repoName: 'test_repo', project: 'test_project' });
       dbRepoHelper.collection.aggregate.mockReturnValueOnce({
         toArray: () => ({
           bucket: {},