KMS-532: Create CSV output for schemes #17
Conversation
htranho
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17 +/- ##
==========================================
+ Coverage 99.36% 99.59% +0.23%
==========================================
Files 42 62 +20
Lines 470 742 +272
Branches 108 159 +51
==========================================
+ Hits 467 739 +272
Misses 3 3 ☔ View full report in Codecov by Sentry. |
| * @param {string} scheme - The scheme to check. | ||
| * @returns {boolean} True if the scheme is a CSV provider URL flag, false otherwise. | ||
| */ | ||
| const getCsvProviderUrlFlag = (scheme) => { |
There was a problem hiding this comment.
rename to isCsvProviderUrlFlag.js to denote it returns a boolean
| @@ -33,6 +34,11 @@ import { toSkosJson } from '@/shared/toSkosJson' | |||
| */ | |||
| export const getConcepts = async (event) => { | |||
There was a problem hiding this comment.
Something is up with the tests, says this line through 134 are no longer covered.
There was a problem hiding this comment.
You might have issue with local branch KMS-532
| vi.mock('../isCsvProviderUrlFlag') | ||
|
|
||
| describe('buildHierarchicalCsvPaths', () => { | ||
| test('should traverse the graph and return paths', async () => { |
There was a problem hiding this comment.
should have describe('when.....) test('should....) structure for all our tests for consistency with MMT.
| vi.restoreAllMocks() | ||
| }) | ||
|
|
||
| it('should create a CSV string with metadata and headers', async () => { |
| * @returns {Promise<String>} A promise that resolves with the CSV string output | ||
| */ | ||
| // eslint-disable-next-line max-len | ||
| export const createCsv = async (csvMetadata, csvHeaders, values) => new Promise((resolve, reject) => { |
| * } | ||
| */ | ||
|
|
||
| export const createCsvForScheme = async (scheme) => { |
| * @param {string} scheme - The scheme name for the XML representation URL | ||
| * @returns {string[]} An array of metadata strings | ||
| */ | ||
| export const getCsvMetadata = async (scheme) => { |
|
Overall PR looks really organized with lots of great comments. Only overarching comment is that some of the functions could probably use examples to give an idea of what the expected data looks like (difficult to tell since it isn't a typed language). You should be able to use continue to help with this. Other than that, anytime we have a list of parameters more than 2 or 3 we should use a dictionary instead, it makes it easier to read. |
| * | ||
| * // Example output: | ||
| * // { | ||
| * // 'http://example.com/provider1': ['BusinessObject1', 'BusinessObject2'], |
There was a problem hiding this comment.
is this a map of provider ids to their corresponding urls, if so maybe just say 'URL1', 'URL2'?
Overview
What is the feature?
Create CSV output for given scheme
What is the Solution?
CSV output interface added
What areas of the application does this impact?
CSV output interface
Testing
For local dev env, use, example for platforms:
http://localhost:4001/dev/concepts?format=csv&scheme=platforms
Attachments
N/A
Checklist