fix reading env var (#18)

Author: moritzraho

README.md

@@ -38,7 +38,7 @@ npm install @adobe/aio-lib-state
   // init
   // init sdk using OpenWhisk credentials
   const state = await stateLib.init({ ow: { namespace, auth } })
-  // init when env vars __OW_AUTH and __OW_NAMESPACE are set (e.g. when running in an OpenWhisk action)
+  // init when env vars __OW_API_KEY and __OW_NAMESPACE are set (e.g. when running in an OpenWhisk action)
   const state = await stateLib.init()
   // or if you want to use your own cloud DB account
   const state = await stateLib.init({ cosmos: { endpoint, masterKey, databaseId, containerId, partitionKey } })

doc/api.md

@@ -22,7 +22,7 @@
 <a href="#module_types..OpenWhiskCredentials">OpenWhisk credentials</a> in
 <code>config.ow</code> or your own
 <a href="#module_types..AzureCosmosMasterCredentials">Azure Cosmos credentials</a> in <code>config.cosmos</code>.</p>
-<p>OpenWhisk credentials can also be read from environment variables <code>__OW_NAMESPACE</code> and <code>__OW_AUTH</code>.</p>
+<p>OpenWhisk credentials can also be read from environment variables <code>__OW_NAMESPACE</code> and <code>__OW_API_KEY</code>.</p>
 </dd>
 </dl>
 
@@ -187,15 +187,15 @@ To use the SDK you must either provide your
 `config.ow` or your own
 [Azure Cosmos credentials](#module_types..AzureCosmosMasterCredentials) in `config.cosmos`.
 
-OpenWhisk credentials can also be read from environment variables `__OW_NAMESPACE` and `__OW_AUTH`.
+OpenWhisk credentials can also be read from environment variables `__OW_NAMESPACE` and `__OW_API_KEY`.
 
 **Kind**: global function  
 **Returns**: [<code>Promise.&lt;StateStore&gt;</code>](#StateStore) - A StateStore instance  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | [config] | <code>object</code> | <code>{}</code> | used to init the sdk |
-| [config.ow] | [<code>OpenWhiskCredentials</code>](#module_types..OpenWhiskCredentials) |  | [OpenWhiskCredentials](#module_types..OpenWhiskCredentials). Set those if you want to use ootb credentials to access the state management service. OpenWhisk namespace and auth can also be passed through environment variables: `__OW_NAMESPACE` and `__OW_AUTH` |
+| [config.ow] | [<code>OpenWhiskCredentials</code>](#module_types..OpenWhiskCredentials) |  | [OpenWhiskCredentials](#module_types..OpenWhiskCredentials). Set those if you want to use ootb credentials to access the state management service. OpenWhisk namespace and auth can also be passed through environment variables: `__OW_NAMESPACE` and `__OW_API_KEY` |
 | [config.cosmos] | [<code>AzureCosmosMasterCredentials</code>](#module_types..AzureCosmosMasterCredentials) \| [<code>AzureCosmosPartitionResourceCredentials</code>](#module_types..AzureCosmosPartitionResourceCredentials) |  | [Azure Cosmos resource credentials](#module_types..AzureCosmosPartitionResourceCredentials) or [Azure Cosmos account credentials](#module_types..AzureCosmosMasterCredentials) |
 | [config.tvm] | <code>object</code> |  | tvm configuration, applies only when passing OpenWhisk credentials |
 | [config.tvm.apiUrl] | <code>string</code> |  | alternative tvm api url. |

e2e/e2e.js

@@ -24,9 +24,9 @@ beforeEach(() => {
 })
 
 const initStateEnv = async (n = 1) => {
-  delete process.env.__OW_AUTH
+  delete process.env.__OW_API_KEY
   delete process.env.__OW_NAMESPACE
-  process.env.__OW_AUTH = process.env[`TEST_AUTH_${n}`]
+  process.env.__OW_API_KEY = process.env[`TEST_AUTH_${n}`]
   process.env.__OW_NAMESPACE = process.env[`TEST_NAMESPACE_${n}`]
   // 1. init will fetch credentials from the tvm using ow creds
   const state = await stateLib.init() // { tvm: { cacheFile: false } } // keep cache for better perf?
@@ -39,9 +39,9 @@ const waitFor = (ms) => new Promise(resolve => setTimeout(resolve, ms))
 
 describe('e2e tests using OpenWhisk credentials (as env vars)', () => {
   test('error bad credentials test: auth is ok but namespace is not', async () => {
-    delete process.env.__OW_AUTH
+    delete process.env.__OW_API_KEY
     delete process.env.__OW_NAMESPACE
-    process.env.__OW_AUTH = process.env.TEST_AUTH_1
+    process.env.__OW_API_KEY = process.env.TEST_AUTH_1
     process.env.__OW_NAMESPACE = process.env.TEST_NAMESPACE_1 + 'bad'
 
     try {

lib/init.js

@@ -37,15 +37,15 @@ async function wrapTVMRequest (promise, params) {
  * `config.ow` or your own
  * [Azure Cosmos credentials]{@link module:types~AzureCosmosMasterCredentials} in `config.cosmos`.
  *
- * OpenWhisk credentials can also be read from environment variables `__OW_NAMESPACE` and `__OW_AUTH`.
+ * OpenWhisk credentials can also be read from environment variables `__OW_NAMESPACE` and `__OW_API_KEY`.
  *
  * @param {object} [config={}] used to init the sdk
  *
  * @param {module:types~OpenWhiskCredentials} [config.ow]
  * {@link module:types~OpenWhiskCredentials}. Set those if you want
  * to use ootb credentials to access the state management service. OpenWhisk
  * namespace and auth can also be passed through environment variables:
- * `__OW_NAMESPACE` and `__OW_AUTH`
+ * `__OW_NAMESPACE` and `__OW_API_KEY`
  *
  * @param {module:types~AzureCosmosMasterCredentials|module:types~AzureCosmosPartitionResourceCredentials} [config.cosmos]
  * [Azure Cosmos resource credentials]{@link module:types~AzureCosmosPartitionResourceCredentials} or