Merge pull request taskcluster#51 from djmitche/bug1499859

Bug 1499859 - use pulseCredentials instead of claimedCredentials

Author: djmitche

services/web-server/README.md

@@ -46,11 +46,14 @@ $ eval $(./taskcluster signin --name taskcluster-web-server)
 
 ### Pulse
 
-To receive pulse messages, you will also need a Pulse namespace and the
-Taskcluster credentials you select must have the scope
-`pulse:namespace:<namespace>`. A member of the administrators for the
-Taskcluster instance you are using can help set that up.  Add the namespace in
-`user-config.yml` as `pulse.namespace`.
+Pulse messages are entirely optional, and most server components do not require
+them. If you do not configure pulse, the server will act as if no pulse
+messages are received, which is sufficient for most development work.
+
+To receive pulse messages, you will also need a Pulse user.  For Mozilla's
+Pulse, you can get such credentials at https://pulseguardian.mozilla.org.  Use
+hostname `pulse.mozilla.org` and vhost `/`. In this situation, set the
+namespace to match the username.
 
 ### Starting
 

services/web-server/config.yml

@@ -24,8 +24,10 @@ defaults:
   # Pulse credentials
   pulse:
     namespace: !env PULSE_NAMESPACE
-    contact: !env PULSE_CONTACT
-    expiresAfter: !env PULSE_EXPIRES_AFTER
+    username: !env PULSE_USERNAME
+    password: !env PULSE_PASSWORD
+    hostname: !env PULSE_HOSTNAME
+    vhost: !env PULSE_VHOST
 
   # config for the github login strategy
   githubLogin:
@@ -44,3 +46,7 @@ development:
   monitoring:
     project: taskcluster-web-server
     mock: true
+
+production:
+  pulse:
+    namespace: taskcluster-web-server

services/web-server/src/PulseEngine/index.js

@@ -1,6 +1,4 @@
 import Debug from 'debug';
-import assert from 'assert';
-import { Client, claimedCredentials } from 'taskcluster-lib-pulse';
 import { slugid } from 'taskcluster-client';
 import { serialize } from 'async-decorators';
 import PulseIterator from './PulseIterator';
@@ -106,51 +104,18 @@ export default class PulseEngine {
    * connection recycles, and rely on the caller to re-subscribe on service
    * restart. */
 
-  constructor({
-    monitor,
-    rootUrl,
-    credentials,
-    namespace,
-    contact,
-    expiresAfter,
-  }) {
+  constructor({ monitor, pulseClient }) {
     this.monitor = monitor;
     this.subscriptions = new Map();
 
-    if (process.env.NODE_ENV === 'production') {
-      assert(namespace, 'namespace is required');
-      assert(
-        credentials && credentials.clientId && credentials.accessToken,
-        'credentials are required'
-      );
-    } else if (
-      !namespace ||
-      !credentials ||
-      !credentials.clientId ||
-      !credentials.accessToken
-    ) {
-      debug(
-        'NOTE: pulse.namespace or taskcluster.credentials not set; no subscription messages will be recieved'
-      );
+    this.client = pulseClient;
 
-      // bail out of setup; this.connected will never be called, so no
-      // subscriptions will ever return messages, but subscription requests
-      // will succeed.
+    if (this.client.isFakeClient) {
+      // we are now set up to accept subscription requests, but won't do
+      // anything with them.
       return;
     }
 
-    this.client = new Client({
-      monitor,
-      namespace,
-      credentials: claimedCredentials({
-        rootUrl,
-        credentials,
-        namespace,
-        contact,
-        expiresAfter,
-      }),
-    });
-
     this.reset();
     this.client.onConnected(conn => this.connected(conn));
   }

services/web-server/src/index.js

@@ -5,6 +5,7 @@ import loader from 'taskcluster-lib-loader';
 import config from 'typed-env-config';
 import monitor from 'taskcluster-lib-monitor';
 import { createServer as httpServer } from 'http';
+import { FakeClient, Client, pulseCredentials } from 'taskcluster-lib-pulse';
 import createApp from './servers/createApp';
 import createContext from './createContext';
 import createSchema from './createSchema';
@@ -43,12 +44,34 @@ const load = loader(
         }),
     },
 
-    pulseEngine: {
+    pulseClient: {
       requires: ['cfg', 'monitor'],
-      setup: ({ cfg, monitor }) =>
+      setup: ({ cfg, monitor }) => {
+        if (!cfg.pulse.namespace) {
+          assert(
+            process.env.NODE_ENV !== 'production',
+            'cfg.pulse.namespace is required'
+          );
+          // eslint-disable-next-line no-console
+          console.log(
+            `\n\nNo Pulse namespace defined; no Pulse messages will be received.`
+          );
+          return new FakeClient();
+        }
+
+        return new Client({
+          monitor,
+          namespace: cfg.pulse.namespace,
+          credentials: pulseCredentials(cfg.pulse),
+        });
+      },
+    },
+
+    pulseEngine: {
+      requires: ['pulseClient', 'monitor'],
+      setup: ({ pulseClient, monitor }) =>
         new PulseEngine({
-          ...cfg.taskcluster,
-          ...cfg.pulse,
+          pulseClient,
           monitor,
         }),
     },

services/web-server/user-config-template.yml

@@ -1,6 +1,9 @@
 defaults:
   taskcluster:
       rootUrl: ...
-  # only set this if you want to receive pulse messages; see the README
-  #pulse:
-    #namespace:
+  pulse:
+    namespace:
+    username: ..
+    password: ..
+    hostname: ..
+    vhost: ..