Artifact creation and validation #2540

d3caf · 2024-08-29T20:52:12Z

This is based on #2538 and adds a script to create the release artifact and validate it.

Todo

Validate artifact with JSON schema
Verify that artifact is properly created
~~Save artifact to filesystem (or in a way that can be published easily by the next step in the process)~~
~~Set up GH action to run script~~

Correct type definition pathing and datasourceIds type Co-authored-by: Zack Stickles <[email protected]>

utils/build-validate-quickstart-artifact.ts

d3caf · 2024-09-03T20:47:27Z

Status

I have the validations running properly and outputting the errors to the console. Next steps would be:

Fix existing quickstarts that are failing validations (they're actually invalid, we just never validated them super closely)
Code cleanup/refactor
Evaluate whether we want to use json-schema-to-ts to generate the TS interface for the artifact (may be unnecessary)
~~Save the artifact in a way that GH actions can use it~~ (will be handled in future tickets)
~~Set up GH action~~ (will be handled in future tickets)

CLAassistant · 2024-09-05T16:32:45Z

All committers have signed the CLA.

Co-authored-by: Mickey Ryan <[email protected]> Co-authored-by: Sarah Kitten <[email protected]>

Co-authored-by: Zack Stickles <[email protected]> Co-authored-by: Sarah Kitten <[email protected]> Co-authored-by: Andrew Anguiano <[email protected]>

utils/lib/DataSource.ts

utils/build-validate-quickstart-artifact.ts

…newrelic/newrelic-quickstarts into campfire/NR-268461-build-validate-artifact

utils/schema/artifact.json

utils/build-validate-quickstart-artifact.ts

zstix · 2024-09-06T16:57:35Z

utils/lib/Alert.ts

+    return alertPaths.map(alertPath => {
+      // The identifier for alerts is the folder and the file name
+      // e.g. `node-js/HighCpuUtilization.yml`
+      const identifier = path.join(...alertPath.split('/').slice(-2, -1));


I know it's not likely, but I always get a little anxious seeing slice (or pop) on arrays since those can technically return [] (and undefined for pop).

Typescript doesn't seem to be angry at this here, but I know that we're using a ! in the Quickstart file to get around this. We might want to consider some additional error checking (or tests) to ensure we for sure have an identifier.

Note: I wouldn't block the PR on this!

Co-authored-by: Joe Gregory <[email protected] Co-authored-by: Sarah Kitten <[email protected]>>

zstix

I found at least one (potential) bug and a few places where we might want to refactor. Additionally, we don't have any tests for this work (something called out in the acceptance criteria).

I'll probably jump in to make these adjustments since this is blocking other work.

utils/build-validate-quickstart-artifact.ts

I have addressed my own feedback. This is going to need someone else to review now.

sarahkitten

This is easy to read and passes when run with the current config changes PR. Small suggestion for the tests but not blocking.

sarahkitten · 2024-09-06T23:02:25Z

utils/__tests__/build-validate-quickstart-artifact.test.js

+        .fn()
+        .mockReturnValueOnce([{ config: 'test-dataSource-1' }]);
+
+      Alert.getAll = jest.fn().mockReturnValueOnce([]);


we might want to test each of these with non-empty values here since we had problems with the getAll returning nothing before!

sarahkitten · 2024-09-06T23:20:04Z

utils/build-validate-quickstart-artifact.ts

+
+    const value = get(artifact, invalidValuePath);
+
+    // Get the specific "component" (e.g. the alert or dashboard) that contains


I appreciate this refactoring and comments!

…github.com/newrelic/newrelic-quickstarts into campfire/NR-268461-build-validate-artifact

d3caf

As the author, I can't approve, but this looks good to me and functions well. I was originally hesitant to bring in lodash for a single use-case, but it does clean it up a bit and using the modularized version is nice 👍 ✅

Andrew Anguiano and others added 8 commits August 29, 2024 16:45

WIP: Creating and validating artifact

0311ab2

WIP: Cleanup

68085ff

feat: Update schema validation

d1a7f25

Correct type definition pathing and datasourceIds type Co-authored-by: Zack Stickles <[email protected]>

fix: Properly get all datasource definitions

bcc7ab4

feat: First pass at error output

1e6e183

feat: Add community dataSourceIds

1de35c9

refactor: Rename datasource to dataSource

0cabd35

feat: Additional error output formatting

0b0ad40

d3caf commented Sep 3, 2024

View reviewed changes

utils/build-validate-quickstart-artifact.ts Outdated Show resolved Hide resolved

Base automatically changed from zstix/NR-268433_qs_json_schema to release September 4, 2024 15:48

Andrew Anguiano and others added 8 commits September 5, 2024 09:30

WIP: Creating and validating artifact

1be1bd8

WIP: Cleanup

c5107b6

fix: Properly get all datasource definitions

556b9cd

feat: First pass at error output

76d9594

feat: Add community dataSourceIds

e9ef407

refactor: Rename datasource to dataSource

b1c5eb6

feat: Additional error output formatting

3a4ddf7

chore: Resolving merge conflicts

82ccc25

zstix and others added 2 commits September 5, 2024 10:31

refactor: Broke up large script to smaller, composable, functions

5343088

Co-authored-by: Mickey Ryan <[email protected]> Co-authored-by: Sarah Kitten <[email protected]>

feat: Fix configs for validation

5338b6b

Co-authored-by: Zack Stickles <[email protected]> Co-authored-by: Sarah Kitten <[email protected]> Co-authored-by: Andrew Anguiano <[email protected]>

mickeyryan42 force-pushed the campfire/NR-268461-build-validate-artifact branch from 0294b60 to 5338b6b Compare September 5, 2024 19:16

mickeyryan42 and others added 3 commits September 5, 2024 16:10

feat: Fix config issues for validation

ec3ceb6

Co-authored-by: Zack Stickles <[email protected]> Co-authored-by: Sarah Kitten <[email protected]> Co-authored-by: Andrew Anguiano <[email protected]>

feat: Remove extra filter

3e48902

refactor: Minor cleanup with error parsing

0ee8e1f

d3caf marked this pull request as ready for review September 5, 2024 21:08

d3caf requested review from a team and josephgregoryii and removed request for a team September 5, 2024 21:08

fix: Correct mongo operator

9fbe659

mickeyryan42 reviewed Sep 6, 2024

View reviewed changes

utils/lib/DataSource.ts Outdated Show resolved Hide resolved

mickeyryan42 reviewed Sep 6, 2024

View reviewed changes

utils/build-validate-quickstart-artifact.ts Outdated Show resolved Hide resolved

feat: Update alerts schema

a54677a

d3caf force-pushed the campfire/NR-268461-build-validate-artifact branch from f2782f4 to a54677a Compare September 6, 2024 15:43

Andrew Anguiano and others added 2 commits September 6, 2024 11:45

chore: Remove debug log

912a627

Merge branch 'campfire/NR-268461-config-fixes' of https://github.com/…

162893d

…newrelic/newrelic-quickstarts into campfire/NR-268461-build-validate-artifact

mickeyryan42 reviewed Sep 6, 2024

View reviewed changes

utils/schema/artifact.json Outdated Show resolved Hide resolved

mickeyryan42 reviewed Sep 6, 2024

View reviewed changes

utils/build-validate-quickstart-artifact.ts Show resolved Hide resolved

zstix reviewed Sep 6, 2024

View reviewed changes

refactor: Add a type guard function to remove the need for as

6c44419

Co-authored-by: Joe Gregory <[email protected] Co-authored-by: Sarah Kitten <[email protected]>>

zstix previously requested changes Sep 6, 2024

View reviewed changes

zstix added 7 commits September 6, 2024 14:11

chore: Reverted flexibility with install directives

8bb1b46

chore: Show a success message when script encounters no errors

ebb74da

refactor: Pull in lodash/get to make access to nested object easier

533e844

chore: Remove unecessary whitespace

9c39df9

chore: Slightly less permissive types

2669874

refactor: Separated error formatting from printing

ba9fc77

test: Ensure logic is correct for building and validating artifact

c10fc26

sarahkitten previously approved these changes Sep 6, 2024

View reviewed changes

mickeyryan42 added 2 commits September 9, 2024 09:18

Merge branch 'campfire/NR-268461-build-validate-artifact' of https://…

1823bef

…github.com/newrelic/newrelic-quickstarts into campfire/NR-268461-build-validate-artifact

test: Add alert and dashboard to tests

a8d98bf

mickeyryan42 dismissed sarahkitten’s stale review via a8d98bf September 9, 2024 13:40

d3caf removed request for aswanson-nr and josephgregoryii September 9, 2024 13:44

mickeyryan42 approved these changes Sep 9, 2024

View reviewed changes

d3caf commented Sep 9, 2024

View reviewed changes

mickeyryan42 merged commit c616b1d into release Sep 9, 2024
17 checks passed

mickeyryan42 deleted the campfire/NR-268461-build-validate-artifact branch September 9, 2024 14:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Artifact creation and validation #2540

Artifact creation and validation #2540

d3caf commented Aug 29, 2024 •

edited

Loading

d3caf commented Sep 3, 2024 •

edited

Loading

CLAassistant commented Sep 5, 2024 •

edited

Loading

zstix Sep 6, 2024

zstix Sep 6, 2024

zstix left a comment

sarahkitten left a comment

sarahkitten Sep 6, 2024

sarahkitten Sep 6, 2024

d3caf left a comment


		const value = get(artifact, invalidValuePath);

		// Get the specific "component" (e.g. the alert or dashboard) that contains

Artifact creation and validation #2540

Artifact creation and validation #2540

Conversation

d3caf commented Aug 29, 2024 • edited Loading

Todo

d3caf commented Sep 3, 2024 • edited Loading

Status

CLAassistant commented Sep 5, 2024 • edited Loading

zstix Sep 6, 2024

Choose a reason for hiding this comment

zstix Sep 6, 2024

Choose a reason for hiding this comment

zstix left a comment

Choose a reason for hiding this comment

sarahkitten left a comment

Choose a reason for hiding this comment

sarahkitten Sep 6, 2024

Choose a reason for hiding this comment

sarahkitten Sep 6, 2024

Choose a reason for hiding this comment

d3caf left a comment

Choose a reason for hiding this comment

d3caf commented Aug 29, 2024 •

edited

Loading

d3caf commented Sep 3, 2024 •

edited

Loading

CLAassistant commented Sep 5, 2024 •

edited

Loading