chore: cache results of vulnerability scans #621

kuzhelov · 2018-12-17T10:24:04Z

Provided changes introduce caching strategy for vulnerability tests - this caching will allow us to stay within monthly quota limit (200 runs per month, while expectation for introduced strategy is 30-60).

Caching Strategy

The strategy is the following:

for each yarn.lock
- run vulnerability scan if there were no any made today, cache result
- otherwise (if today's cached result present) just skip vulnerability tests

DustyTheBot · 2018-12-17T10:31:57Z

	Warnings
⚠️	There are no updates provided to CHANGELOG. Ensure there are no publicly visible changes introduced by this PR.

Generated by 🚫 dangerJS

layershifter · 2018-12-18T10:08:45Z

.circleci/config.yml

      - run:
          name: Vulnerability Tests
          command: yarn test:vulns
+      - save_cache:
+          key: v1-vuln-scans-{{ checksum "yarn.lock" }}-{{ epoch }}


Is it okay that we restoring a cache with a key without the epoch variable?

this is necessary because otherwise Circle CI won't update the cache entry if it has existed before (this is its feature). To avoid this 'rewrite ban' the following strategy was suggested: https://discuss.circleci.com/t/add-mechanism-to-update-existing-cache-key/9014/12

As we discussed, please add a small comment with this link before the key line 👍

agreed to introduce comment for that

layershifter · 2018-12-18T10:18:21Z

build/gulp/tasks/test-vulns.ts

+
+const ensureDirExists = path => {
+  if (!fs.existsSync(path)) {
+    sh(`mkdir -p ${path}`)


fs.mkdirSync(path, { recursive: true })?

for that we need Node LTS v10 (and this is, actually, the step we should make). Agreed to defer it to the follow-up PR, to be absolutely sure that all the necessary accompanying adjustments to the code will be made

layershifter · 2018-12-18T10:19:17Z

build/gulp/tasks/test-vulns.ts

+
+const getScanResultsDirPath = () => {
+  return paths.base(SCAN_RESULTS_DIR_NAME)
+}


Do we actually need it? As I see it can be a simple variable

layershifter · 2018-12-18T10:20:08Z

build/gulp/tasks/test-vulns.ts

+  const now = new Date()
+
+  const fileName = `snyk-scanned-${now.getUTCFullYear()}-${now.getUTCMonth() +
+    1}-${now.getUTCDate()}`


Can we split this to multiple variables? To avoid multiline there

layershifter

I left small questions there. I prefer to use pure bash commands for such things, but it will be hard to debug them for others.

Let's ship it.

* implement caching strategy * adjust file name of scan marker * add yarn lock hash to marker file name * add change to build config * fix dir name in build config * improve caching strategy * just restore cache * temporary remove lint and tests * try * fix caching strategy * try * try * try * try epoch * create file on scan * return lint and test steps * introduce comment for the caching approach taken * remove unnecessary function * simplify expression for marker file name

* feat(menuItem: add menu prop) * Only one submenu open at a time * Fix bug: submenu noe closes on clicking a menuItem with no submenu * Code cleanup * Remove the activeIndex prop passed to the menuItem * Remove Popup and implement submenu without it * initial keyboard support * left/right arrow handling * simplify keyboard handlers * -fixed import in the MenuItem * -added submenuIndicator -small fixes in the styles and the way the submenu is generated * -clicking on leaf element should close the submenus (the same should be done for enter/space) -applied consistent (left-right) navigation for horizontal menu and (up-down) navigation for vertical menu * -implemented outside click to close all menus -implemented enter key on leaf menu item to close the menu * -fixed import * -refactored MenuItem handlers - fixed issues -removed onClick handler for the Menu (not necessary for now) -added onKeyDown in the creation of the MenuItem in the Menu component for handling the action prop * -added setActiveIndex callback and removed onKeyDown in the creation of MenuItems in the Menu component * -right arrow key is closing the submenus and goes to the next element if the menu is horizontal, or is focusing the first MenuItem if it is vertical * -handled left arrow key * -changed ref -focus trap wip * -added Ref component instead of using the itemRef on the ElementType -removed subscription for focus * -fixes * -moved ref //TODO: figure out tests failing * -close menu on outside focus * -improved comments * -fixed escape key not focusing the active element -changed parentRef to inSubmenu boolean * -fixing key problems -added dependency for generating id * -refactored submenuRef element * fix broken tests * -added comments in the tests -changed the submenuDomElement so submenuRef * -renamed inSubmenu to submenu prop in the Menu * -fixed with the auto-controlled prop in the Menu * -added state interface in the Menu -improved menu variables' names * -fixed variables in examples * -remove state initialization in the MenuItem component * -added new handler for escape -changed submenu examples titles * -refactored conditions using doesNodeContainClick * -renamed submenu* props to menu in the MenuItem component -changed setActiveIndex with onActiveChanged -introduced different styles for the hovering vs active elements * -improved example -fixed issue with the condition for the active prop * -exported MenuState -added correct typings to the menuStyles * -fixed underlined active + hovered style * -fixed border corner clipped by adding custom styles for the first child menu items and the last child menu items in vertical menu * -addressed comments on PR * chore: prepare release 0.15.0 [ci skip] * 0.15.0 * fix(Prototype): Fix Popover prototype after breaking changes (#623) * chore: cache results of vulnerability scans (#621) * implement caching strategy * adjust file name of scan marker * add yarn lock hash to marker file name * add change to build config * fix dir name in build config * improve caching strategy * just restore cache * temporary remove lint and tests * try * fix caching strategy * try * try * try * try epoch * create file on scan * return lint and test steps * introduce comment for the caching approach taken * remove unnecessary function * simplify expression for marker file name * feat(text): color prop (#597) * feat(text): color prop * addressed comments * changelog * amended changelog * made text color override other props that change color * feat(header): header and header description color prop (#628) * feat(header): header and header description color prop * changelog * fixed examples * addressed PR comments * fix(Popup): allow to 'detach' from trigger and RTL adjustments (#612) * introduce offset prop * correct description of supported values * update changelog * introduce fix * ensure RTL is properly applied to complex offset expressions * rename method to make logic more expressive * add unit tests * remove unnecessary grid props from offset example * update changelog * fix(SelectableList): Items in list should be selectable (#566) * Reflect which item is selected in list * Make list derived from autocontrolled component * small fix * Update ListExampleSelection.tsx * Update ListExampleSelection.shorthand.tsx * Small improvement * Rename *ItemIndex -> *Index * Names refactoring * Minor improvements * update changelog * Add onSelectedIndexChange * Add some tests * Small improvements afer CR * Small improvements afer CR * Small improvements afer CR * create focus handler when List is constructed * fix changelog * changelog * docs(Examples): allow to use TS in examples (#617) * docs(Examples): allow to use TS in examples * add jsdoc * fix typo * rename file * add comment * `createExample` to `createExampleSourceCode` * rework with `path.relative()` * remove JSON files on remove tsx * create getRelativePathToSource function * -updated changelog * -updated changelog * -updated changelog with breaking changes -removed TODO comment * -fixed imports in examples

kuzhelov-ms added 4 commits December 17, 2018 00:12

implement caching strategy

c221ed0

adjust file name of scan marker

374fce2

add yarn lock hash to marker file name

f585290

add change to build config

144aaa7

kuzhelov requested review from dvdzkwsk, layershifter, levithomason, miroslavstastny and mnajdova as code owners December 17, 2018 10:24

kuzhelov added the 🚧 WIP label Dec 17, 2018

kuzhelov-ms added 12 commits December 17, 2018 11:37

fix dir name in build config

e66b554

improve caching strategy

25a8a62

just restore cache

9e3f0fc

temporary remove lint and tests

a662a54

try

a74b4c9

fix caching strategy

af24263

try

ba74944

try

6c3861c

try

19922c9

try epoch

b0ce4b0

create file on scan

63adf2e

return lint and test steps

30d805e

kuzhelov added 🚀 ready for review and removed 🚧 WIP labels Dec 17, 2018

layershifter reviewed Dec 18, 2018

View reviewed changes

layershifter added the needs author feedback Author's opinion is asked label Dec 18, 2018

layershifter removed the 🚀 ready for review label Dec 18, 2018

layershifter approved these changes Dec 18, 2018

View reviewed changes

kuzhelov-ms and others added 4 commits December 18, 2018 11:32

introduce comment for the caching approach taken

4537020

remove unnecessary function

29e1e63

simplify expression for marker file name

67ce5d4

Merge branch 'master' into feat/vulnerability-scan-results-caching

73ca81c

kuzhelov added ready for merge and removed needs author feedback Author's opinion is asked labels Dec 18, 2018

kuzhelov merged commit 359a083 into master Dec 18, 2018

kuzhelov deleted the feat/vulnerability-scan-results-caching branch December 18, 2018 11:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: cache results of vulnerability scans #621

chore: cache results of vulnerability scans #621

kuzhelov commented Dec 17, 2018 •

edited

Loading

DustyTheBot commented Dec 17, 2018

layershifter Dec 18, 2018 •

edited

Loading

kuzhelov Dec 18, 2018 •

edited

Loading

layershifter Dec 18, 2018

kuzhelov Dec 18, 2018

layershifter Dec 18, 2018

kuzhelov Dec 18, 2018

layershifter Dec 18, 2018

layershifter Dec 18, 2018

layershifter left a comment

chore: cache results of vulnerability scans #621

chore: cache results of vulnerability scans #621

Conversation

kuzhelov commented Dec 17, 2018 • edited Loading

Caching Strategy

DustyTheBot commented Dec 17, 2018

layershifter Dec 18, 2018 • edited Loading

Choose a reason for hiding this comment

kuzhelov Dec 18, 2018 • edited Loading

Choose a reason for hiding this comment

layershifter Dec 18, 2018

Choose a reason for hiding this comment

kuzhelov Dec 18, 2018

Choose a reason for hiding this comment

layershifter Dec 18, 2018

Choose a reason for hiding this comment

kuzhelov Dec 18, 2018

Choose a reason for hiding this comment

layershifter Dec 18, 2018

Choose a reason for hiding this comment

layershifter Dec 18, 2018

Choose a reason for hiding this comment

layershifter left a comment

Choose a reason for hiding this comment

kuzhelov commented Dec 17, 2018 •

edited

Loading

layershifter Dec 18, 2018 •

edited

Loading

kuzhelov Dec 18, 2018 •

edited

Loading