Merge pull request #490 from snyk/refactor/snyk-api-url

refactor: default SNYK_API to  api.snyk.io/v1

Author: Noa-Savransky

docs/import.md

@@ -190,7 +190,7 @@ If you have any tests ot fixtures that should be ignored, please set the `exclus
 - `SNYK_TOKEN` - your [Snyk api token](https://app.snyk.io/account)
 - `SNYK_LOG_PATH` - the path to folder where all logs should be saved,it is recommended creating a dedicated logs folder per import you have running. (Note: all logs will append)
 - `CONCURRENT_IMPORTS` (optional) defaults to 15 repos at a time, which is the recommended amount to import at once as a max. Just 1 repo may have many projects inside which can trigger a many files at once to be requested from the user's SCM instance and some may have rate limiting in place. This script aims to help reduce the risk of hitting a rate limit.
-- `SNYK_API` (optional) defaults to `https://snyk.io/api/v1`
+- `SNYK_API` (optional) defaults to `https://api.snyk.io/v1`
 
 ## 3. Download & run
 

docs/sync.md

@@ -92,7 +92,7 @@ The command will produce detailed logs for projects that were `updated` and thos
 
 - `SNYK_TOKEN` - your [Snyk api token](https://app.snyk.io/account)
 - `SNYK_LOG_PATH` - the path to folder where all logs should be saved,it is recommended creating a dedicated logs folder per import you have running. (Note: all logs will append)
-- `SNYK_API` (optional) defaults to `https://snyk.io/api/v1`
+- `SNYK_API` (optional) defaults to `https://api.snyk.io/v1`
 - `GITHUB_TOKEN` - SCM token that has read level or similar permissions to see information about repos like default branch & can list files in a repo
 
 ## 2. Download & run

package.json

@@ -50,7 +50,7 @@
     "bunyan": "1.8.15",
     "debug": "4.3.4",
     "lodash": "4.17.21",
-    "micromatch": "4.0.6",
+    "micromatch": "4.0.8",
     "needle": "2.9.1",
     "p-map": "4.0.0",
     "parse-link-header": "2.0.0",

src/lib/get-snyk-host.ts

@@ -1,3 +1,3 @@
 export function getSnykHost(): string {
-  return process.env.SNYK_API || 'https://snyk.io/api/v1';
+  return process.env.SNYK_API || 'https://api.snyk.io/v1';
 }

test/lib/fixtures/non-empty.logx

@@ -1,2 +1,2 @@
-{"name":"snyk:import-projects-script","hostname":"MacBook-Pro-2.local","pid":46657,"level":30,"target":{"name":"composer-with-vulns","owner":"api-import-circle-test","branch":"master"},"locationUrl":"https://dev.snyk.io/api/v1/org/ORG_ID/integrations/INTEGRATION_ID/import/IMPORT_ID","orgId":"ORG_ID","integrationId":"INTEGRATION_ID","targetId":"ORG_ID:INTEGRATION_ID:composer-with-vulns:api-import-circle-test:master","msg":"Target requested for import","time":"2020-10-26T14:53:20.234Z","v":0}
+{"name":"snyk:import-projects-script","hostname":"MacBook-Pro-2.local","pid":46657,"level":30,"target":{"name":"composer-with-vulns","owner":"api-import-circle-test","branch":"master"},"locationUrl":"https://api.dev.snyk.io/v1/org/ORG_ID/integrations/INTEGRATION_ID/import/IMPORT_ID","orgId":"ORG_ID","integrationId":"INTEGRATION_ID","targetId":"ORG_ID:INTEGRATION_ID:composer-with-vulns:api-import-circle-test:master","msg":"Target requested for import","time":"2020-10-26T14:53:20.234Z","v":0}
 {"name":"snyk:import-projects-script","hostname":"MacBook-Pro-2.local","pid":46657,"level":30,"target":{"name":"composer-with-vulns","owner":"api-import-circle-test","branch":"master"},"locationUrl":null,"orgId":"ORG_ID","integrationId":"INTEGRATION_ID","targetId":"ORG_ID:INTEGRATION_ID:composer-with-vulns:api-import-circle-test:master","msg":"Target exists in Snyk","time":"2020-10-26T14:53:20.234Z","v":0}

test/scripts/__mocks__/snyk-request-manager.ts

@@ -20,7 +20,7 @@ export class requestsManager {
           statusCode: 201,
           headers: {
             location:
-              'https://app.snyk.io/api/v1/org/ORG-ID/integrations/INTEGRATION-ID/import/IMPORT-ID',
+              'https://api.snyk.io/v1/org/ORG-ID/integrations/INTEGRATION-ID/import/IMPORT-ID',
           },
         });
       }

test/scripts/polling.test.ts

@@ -49,7 +49,7 @@ describe('Logs failed polls', () => {
     await new Promise((r) => setTimeout(r, 300));
     const failedLog = fs.readFileSync(failedPollsLogName, 'utf8');
     expect(failedLog).toMatch(
-      `"level":50,"orgId":"ORG-ID","locationUrl":"https://app.snyk.io/api/v1/org/ORG-ID/integrations/INTEGRATION-ID/import/IMPORT-ID","errorMessage":{"statusCode":500,"error":{"message":"Error calling Snyk api"}},"msg":"Failed to poll url"`,
+      `"level":50,"orgId":"ORG-ID","locationUrl":"https://api.snyk.io/v1/org/ORG-ID/integrations/INTEGRATION-ID/import/IMPORT-ID","errorMessage":{"statusCode":500,"error":{"message":"Error calling Snyk api"}},"msg":"Failed to poll url"`,
     );
   }, 240000);
 });

test/system/orgs:data/gitlab.test.ts

@@ -26,7 +26,7 @@ describe('General `snyk-api-import orgs:data <...>`', () => {
         expect(stderr).toEqual('');
         expect(err).toBeNull();
         expect(stdout).toMatch(
-          'Found 6 group(s). Written the data to file: group-hello-gitlab-orgs.json',
+          'Found 7 group(s). Written the data to file: group-hello-gitlab-orgs.json',
         );
         deleteFiles([
           path.resolve(__dirname, `group-${groupId}-gitlab-orgs.json`),