chore: update readme and examples for default credential provider and…

… new topics callbacks (#1429) * chore: update readme and examples for default credential provider and new topics callbacks * fix lint errors * revert dictionary file changes, omit optional config in basic files too * edits in storage and leaderboards examples
momentohq · Aug 30, 2024 · 8f9a09e · 8f9a09e
1 parent ae97ce6
commit 8f9a09e
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 63 deletions.
diff --git a/README.template.md b/README.template.md
@@ -16,6 +16,16 @@ is best suited for a particular environment:
 {% include "./examples/nodejs/cache/readme.ts" %}
 ```
 
+You'll need a Momento API key to authenticate with Momento. You can get one from the [Momento Console](https://console.gomomento.com/caches).
+
+By default, Momento clients use a `CredentialProvider` that expects an environment variable named `MOMENTO_API_KEY`
+
+```bash
+export MOMENTO_API_KEY=<your Momento API key here>
+```
+
+Note: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security. See [these docs](https://docs.momentohq.com/cache/develop#instantiating-credential-providers-using-momento-api-keys) for more information about instantiating your own `CredentialProvider`.
+
 ## Getting Started and Documentation
 
 Documentation is available on the [Momento Docs website](https://docs.momentohq.com). For information specific to a

diff --git a/examples/nodejs/cache/basic.ts b/examples/nodejs/cache/basic.ts
@@ -1,16 +1,7 @@
-import {
-  CacheClient,
-  Configurations,
-  CredentialProvider,
-  CreateCacheResponse,
-  CacheSetResponse,
-  CacheGetResponse,
-} from '@gomomento/sdk';
+import {CacheClient, CreateCacheResponse, CacheSetResponse, CacheGetResponse} from '@gomomento/sdk';
 
 async function main() {
   const momento = await CacheClient.create({
-    configuration: Configurations.Laptop.v1(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
     defaultTtlSeconds: 60,
   });
 

diff --git a/examples/nodejs/cache/doc-example-files/cheat-sheet-main.ts b/examples/nodejs/cache/doc-example-files/cheat-sheet-main.ts
@@ -1,10 +1,8 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import {CacheClient, Configurations, CredentialProvider} from '@gomomento/sdk';
+import {CacheClient} from '@gomomento/sdk';
 
 async function main() {
   const cacheClient = await CacheClient.create({
-    configuration: Configurations.Laptop.v1(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
     defaultTtlSeconds: 60,
   });
 }

diff --git a/examples/nodejs/cache/leaderboard.ts b/examples/nodejs/cache/leaderboard.ts
@@ -1,7 +1,6 @@
 import {
   PreviewLeaderboardClient,
   LeaderboardConfigurations,
-  CredentialProvider,
   CacheClient,
   Configurations,
   LeaderboardOrder,
@@ -16,12 +15,11 @@ import {
 } from '@gomomento/sdk';
 
 async function main() {
-  // NOTE: trace logging to view leaderboard interactions; might want to disable in production to save log noise and
-  // switch to ERROR or info
+  // NOTE: you can use TRACE level logging to view leaderboard interactions, but you likely want to
+  // disable that in production to save log noise by switching to ERROR or INFO level instead.
   const loggerFactory = new DefaultMomentoLoggerFactory(DefaultMomentoLoggerLevel.TRACE);
   const cacheClient = await CacheClient.create({
     configuration: Configurations.Laptop.v1(loggerFactory),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
     defaultTtlSeconds: 60,
   });
 
@@ -37,10 +35,7 @@ async function main() {
       throw createCacheResponse.innerException();
   }
 
-  const client = new PreviewLeaderboardClient({
-    configuration: LeaderboardConfigurations.Laptop.v1(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
-  });
+  const client = new PreviewLeaderboardClient({});
 
   // Create a leaderboard with given cache and leaderboard names
   const leaderboard = client.leaderboard('my-cache', 'my-leaderboard');

diff --git a/examples/nodejs/cache/readme.ts b/examples/nodejs/cache/readme.ts
@@ -1,9 +1,7 @@
-import {CacheClient, CacheGetResponse, Configurations, CredentialProvider} from '@gomomento/sdk';
+import {CacheClient, CacheGetResponse} from '@gomomento/sdk';
 
 async function main() {
   const cacheClient = await CacheClient.create({
-    configuration: Configurations.Laptop.v1(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
     defaultTtlSeconds: 60,
   });
 

diff --git a/examples/nodejs/storage/basic.ts b/examples/nodejs/storage/basic.ts
@@ -1,17 +1,7 @@
-import {
-  CreateStoreResponse,
-  CredentialProvider,
-  PreviewStorageClient,
-  StorageConfigurations,
-  StorageGetResponse,
-  StoragePutResponse,
-} from '@gomomento/sdk';
+import {CreateStoreResponse, PreviewStorageClient, StorageGetResponse, StoragePutResponse} from '@gomomento/sdk';
 
 async function main() {
-  const storageClient = new PreviewStorageClient({
-    configuration: StorageConfigurations.Laptop.latest(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
-  });
+  const storageClient = new PreviewStorageClient({});
 
   const storeName = 'my-store';
   const createStoreResponse = await storageClient.createStore(storeName);

diff --git a/examples/nodejs/storage/doc-example-files/cheat-sheet-main.ts b/examples/nodejs/storage/doc-example-files/cheat-sheet-main.ts
@@ -1,7 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import {CredentialProvider, PreviewStorageClient, StorageConfigurations} from '@gomomento/sdk';
+import {PreviewStorageClient, StorageConfigurations} from '@gomomento/sdk';
 
 const storageClient = new PreviewStorageClient({
   configuration: StorageConfigurations.Laptop.latest(),
-  credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
 });
diff --git a/examples/nodejs/topics/doc-example-files/cheat-sheet-main.ts b/examples/nodejs/topics/doc-example-files/cheat-sheet-main.ts
@@ -4,7 +4,6 @@ import {TopicClient, TopicConfigurations, CredentialProvider} from '@gomomento/s
 function main() {
   const cacheClient = new TopicClient({
     configuration: TopicConfigurations.Default.latest(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
   });
 }
 

diff --git a/examples/nodejs/topics/package-lock.json b/examples/nodejs/topics/package-lock.json
diff --git a/examples/nodejs/topics/topic-publish.ts b/examples/nodejs/topics/topic-publish.ts
@@ -1,4 +1,4 @@
-import {TopicClient, CredentialProvider, TopicConfigurations, TopicPublishResponse} from '@gomomento/sdk';
+import {TopicClient, TopicPublishResponse} from '@gomomento/sdk';
 
 import {ensureCacheExists} from './utils/cache';
 
@@ -9,10 +9,7 @@ async function main() {
     return;
   }
   const [cacheName, topicName, value] = clargs;
-  const momento = new TopicClient({
-    configuration: TopicConfigurations.Default.latest(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
-  });
+  const momento = new TopicClient({});
 
   await ensureCacheExists(cacheName);
 

diff --git a/examples/nodejs/topics/topic-subscribe.ts b/examples/nodejs/topics/topic-subscribe.ts
@@ -2,9 +2,9 @@ import {
   TopicClient,
   TopicItem,
   TopicSubscribe,
-  CredentialProvider,
-  TopicConfigurations,
   TopicSubscribeResponse,
+  TopicDiscontinuity,
+  TopicHeartbeat,
 } from '@gomomento/sdk';
 import {ensureCacheExists} from './utils/cache';
 
@@ -15,17 +15,16 @@ async function main() {
     return;
   }
   const [cacheName, topicName] = clargs;
-  const momento = new TopicClient({
-    configuration: TopicConfigurations.Default.latest(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
-  });
+  const momento = new TopicClient({});
 
   await ensureCacheExists(cacheName);
 
   console.log(`Subscribing to cacheName=${cacheName}, topicName=${topicName}`);
   const response = await momento.subscribe(cacheName, topicName, {
     onItem: handleItem,
     onError: handleError,
+    onDiscontinuity: handleDiscontinuity,
+    onHeartbeat: handleHeartbeat,
   });
 
   switch (response.type) {
@@ -57,6 +56,14 @@ function handleError(error: TopicSubscribe.Error) {
   //subscription.unsubscribe();
 }
 
+function handleDiscontinuity(discontinuity: TopicDiscontinuity) {
+  console.log('Discontinuity received from topic subscription');
+}
+
+function handleHeartbeat(heartbeat: TopicHeartbeat) {
+  console.log('Heartbeat received from topic subscription');
+}
+
 main()
   .then(() => {
     console.log('success!!');

diff --git a/examples/web/cache/basic.ts b/examples/web/cache/basic.ts
@@ -1,20 +1,11 @@
-import {
-  CacheClient,
-  Configurations,
-  CredentialProvider,
-  CreateCacheResponse,
-  CacheSetResponse,
-  CacheGetResponse,
-} from '@gomomento/sdk-web';
+import {CacheClient, CreateCacheResponse, CacheSetResponse, CacheGetResponse} from '@gomomento/sdk-web';
 import {initJSDom} from './utils/jsdom';
 
 async function main() {
   // Because the Momento Web SDK is intended for use in a browser, we use the JSDom library to set up an environment
   // that will allow us to use it in a node.js program.
   initJSDom();
   const momento = new CacheClient({
-    configuration: Configurations.Laptop.v1(),
-    credentialProvider: CredentialProvider.fromEnvironmentVariable('MOMENTO_API_KEY'),
     defaultTtlSeconds: 60,
   });