snowflake-promise - npm Package Compare versions

Comparing version 1.11.0 to 2.0.0

CHANGELOG.md

@@ -0,1 +1,26 @@
+### 2.0.0
+
[phone]
+
+* **BREAKING CHANGE**: Minimum supported Node version is 6.9.5, the same as the underlying
+  Snowflake SDK.
+* Update to `snowflake-sdk` 1.3.0
+* Update dev dependencies to latest versions
+* Move the repository from Bitbucket to Github
+* Support the new `ocspFailOpen` configuration option — thank you @thoean (Markus Thurner)
+* Bugfix for `getStatementId` - thank you @jasonstitt (Jason Stitt)
+
+The biggest change is to support the `ocspFailOpen` option in the underlying
+Snowflake SDK driver.
+
+This setting is enabled by default. if OCSP verification fails due to an invalid response
+from the certificate authority, the connection will still be established. (If OCSP
+verification shows that the certificate is revoked, the connection will be dropped.)
+
+This prevents connection failures that previously happened when an OCSP provider had an
+outage. The earlier workaround was to set the `insecureConnect` option. That is deprecated
+and will be ignored. The new defaults accomplish the same thing in a more secure manner.
+
+For more information, see: <https://www.snowflake.com/blog/changes-to-how-snowflake-handles-ocsp/>
+
 ### 1.11.0
@@ -19,3 +44,3 @@
 
-* Workaround for OCSP errors when creating the client:
+* [DEPRECATED in 1.12.0] Workaround for OCSP errors when creating the client:
 
@@ -22,0 +47,0 @@ ```

package.json

 {
   "name": "snowflake-promise",
-  "version": "1.11.0",
+  "version": "2.0.0",
   "description": "A Promise-based, TypeScript-friendly wrapper for the Snowflake SDK",
-  "repository": "bitbucket:adp-developers/snowflake-promise.git",
-  "bugs": "https://bitbucket.org/adp-developers/snowflake-promise/issues",
+  "repository": "github:natesilva/snowflake-promise",
+  "bugs": "https://github.com/natesilva/snowflake-promise/issues",
   "license": "MIT",
@@ -15,21 +15,21 @@ "author": "Nate Silva <[e-mail]>",
   ],
-  "main": "prod/index.js",
-  "types": "prod/index.d.ts",
+  "main": "build/src/index.js",
+  "types": "build/src/index.d.ts",
   "scripts": {
-    "prepare": "del-cli prod && tsc"
+    "prepare": "del-cli build && tsc"
   },
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=6.9.5"
   },
   "devDependencies": {
-    "@types/node": "^11.13.17",
-    "del-cli": "^2.0.0",
-    "np": "^5.0.3",
+    "@types/node": "^11.13.20",
+    "del-cli": "^3.0.0",
+    "np": "^5.1.0",
     "ts-node": "^8.3.0",
-    "tslint": "^5.18.0",
-    "typescript": "^3.5.3"
+    "tslint": "^5.20.0",
+    "typescript": "^3.6.3"
   },
   "dependencies": {
-    "snowflake-sdk": "^1.1.15"
+    "snowflake-sdk": "^1.3.0"
   }
 }

README.md

@@ -41,7 +41,25 @@ # snowflake-promise [![npm](https://img.shields.io/npm/v/snowflake-promise.svg)](https://www.npmjs.com/package/snowflake-promise) [![node](https://img.shields.io/node/v/snowflake-promise.svg)](https://www.npmjs.com/package/snowflake-promise)
 
+## Connecting
+
+The constructor takes up to three arguments:
+
+`new Snowflake(connectionOptions, [ loggingOptions, [ configureOptions ] ])`
+
+* `connectionOptions`
+  * Supported options are here: <https://docs.snowflake.net/manuals/user-guide/nodejs-driver-use.html#required-connection-options>
+* `loggingOptions`
+  * `logSql` (optional, function): If provided, this function will be called to log SQL
+    statements. For example, set `logSql` to `console.log` to log all issued SQL
+    statements to the console.
+  * `logLevel` (optional: `'error' | 'warn' | 'debug' | 'info' | 'trace'`): Turns on
+    SDK-level logging.
+* `configureOptions`
+  * `ocspFailOpen` (optional, boolean) (default: `true`): Enables OCSP fail-open
+    functionality. See <https://www.snowflake.com/blog/latest-changes-to-how-snowflake-handles-ocsp/> for more information.
+
 ## More examples
 
-* [Streaming result rows](https://bitbucket.org/adp-developers/snowflake-promise/src/master/examples/streaming.js)
-* [Using traditional Promise `then` syntax (and older versions of Node.js)](https://bitbucket.org/adp-developers/snowflake-promise/src/master/examples/oldSchool.js)
-    * Node 4.0.0 is the oldest supported version
-* [Turn on logging](https://bitbucket.org/adp-developers/snowflake-promise/src/master/examples/logging.js)
+* [Streaming result rows](examples/streaming.js)
+* [Using traditional Promise `then` syntax (and older versions of Node.js)](examples/oldSchool.js)
+    * Node v6.9.5 is the oldest supported version
+* [Turn on logging](examples/logging.js)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

65

increased by38.3%

Worsened metrics

Total package byte prevSize

35127

decreased by-18.31%

Number of package files

37

decreased by-19.57%

Lines of code

526

decreased by-36.78%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updatedsnowflake-sdk@^1.3.0