refactor: rename service-dog -> companion

.eslintignore

@@ -10,3 +10,4 @@ website/themes/uppy/source/js/uppy.js
 website/themes/uppy/source/uppy/**
 test/endtoend/*/build
 bundle.js
+packages/@uppy/companion

.travis.yml

@@ -21,7 +21,7 @@ script:
 - npm run web:install
 - npm run build
 - npm run test
-- npm run test:service-dog
+- npm run test:companion
 - if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then npm run test:acceptance; fi
 - npm run uploadcdn
 env:

bin/build-lib.js

@@ -11,7 +11,7 @@ const writeFile = promisify(fs.writeFile)
 
 const SOURCE = 'packages/{*,@uppy/*}/src/**/*.js'
 // Files not to build (such as tests)
-const IGNORE = /\.test\.js$|__mocks__|service-dog/
+const IGNORE = /\.test\.js$|__mocks__|companion/
 
 async function buildLib () {
   const files = await glob(SOURCE)

bin/service-dog → bin/companion

@@ -1,11 +1,11 @@
 #!/usr/bin/env bash
 sh ../env.sh
 
-export UPPYSERVER_DATADIR="./packages/@uppy/service-dog/output"
+export UPPYSERVER_DATADIR="./packages/@uppy/companion/output"
 export UPPYSERVER_DOMAIN="localhost:3020"
 export UPPYSERVER_PROTOCOL="http"
 export UPPYSERVER_PORT=3020
 export UPPY_ENDPOINTS=""
 export UPPYSERVER_SECRET="development"
 
-nodemon --exec node ./packages/@uppy/service-dog/src/standalone/start-server.js
+nodemon --exec node ./packages/@uppy/companion/src/standalone/start-server.js

package.json

@@ -90,7 +90,7 @@
     "lint": "eslint . --cache",
     "lint-staged": "lint-staged",
     "release": "./bin/release",
-    "start:service-dog": "sh ./bin/service-dog",
+    "start:companion": "sh ./bin/companion",
     "start": "npm-run-all --parallel watch start:server web:preview",
     "test:registry": "verdaccio --listen 4002 --config test/endtoend/verdaccio.yaml",
     "test:build": "./bin/endtoend-build",
@@ -101,7 +101,7 @@
     "test:unit": "jest --testPathPattern=./src --coverage",
     "test:type": "tsc -p .",
     "test": "npm run lint && npm run test:unit && npm run test:type",
-    "test:service-dog": "cd ./packages/@uppy/service-dog && npm run test",
+    "test:companion": "cd ./packages/@uppy/companion && npm run test",
     "test:watch": "jest --watch --testPathPattern=src",
     "travis:deletecache": "travis cache --delete",
     "watch:css": "onchange 'packages/**/*.scss' --initial --verbose -- npm run build:css",

packages/@uppy/service-dog/.gitignore → packages/@uppy/companion/.gitignore

@@ -40,5 +40,5 @@ test/output/*
 
 # Transpiled
 lib/
-infra/kube/service-dog/uppy-env.yaml
+infra/kube/companion/uppy-env.yaml
 scripts/.tl-deploy-hosts-danger.txt

packages/@uppy/service-dog/ARCHITECTURE.md → packages/@uppy/companion/ARCHITECTURE.md

@@ -25,8 +25,8 @@ redirects to Google's oAuth page.  So on the client side, you just need to link
 
 After the user completes the oAuth flow, they should always be redirected to `https://your-server/:provider/callback`.
 The `/:provider/callback` routes are handled by the `callback` controller at `server/controllers/callback.js`.  
-This controller receives the oAuth token, generates a json web token with it, and sends the generated json web token to the client by adding it to the cookies. This way service-dog doesn't have to save users' oAuth tokens (which is good from the security perspective).
-This json web token would be sent to service-dog in subsequent requests and the oAuth token can be read from it.
+This controller receives the oAuth token, generates a json web token with it, and sends the generated json web token to the client by adding it to the cookies. This way companion doesn't have to save users' oAuth tokens (which is good from the security perspective).
+This json web token would be sent to companion in subsequent requests and the oAuth token can be read from it.
 
 ## Routing And Controllers
 There are four generic routes:
@@ -81,4 +81,4 @@ One issue here is that `Grant` has different versions for Koa, Express, and Hapi
 All of this may be more trouble than it's worth if no one needs it, so I'd get some community feedback beforehand.
 
 ## Allow users to add new providers
-Suppose a developer wants to use Uppy with a third party API provider that we don't support.  There needs to be some way for them to be able to add their own custom providers, hopefully without having to edit `service-dog`'s source (adding files to `server/providers`).
+Suppose a developer wants to use Uppy with a third party API provider that we don't support.  There needs to be some way for them to be able to add their own custom providers, hopefully without having to edit `companion`'s source (adding files to `server/providers`).

packages/@uppy/service-dog/docker-compose-dev.yml → packages/@uppy/companion/docker-compose-dev.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   uppy:
-    image: service-dog
+    image: companion
     build:
       context: .
       dockerfile: Dockerfile

packages/@uppy/service-dog/docker-compose-test.yml → packages/@uppy/companion/docker-compose-test.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   uppy:
-    image: service-dog
+    image: companion
     build:
       context: .
       dockerfile: Dockerfile.test

packages/@uppy/service-dog/docker-compose.yml → packages/@uppy/companion/docker-compose.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   uppy:
-    image: service-dog
+    image: companion
     build:
       context: .
       dockerfile: Dockerfile

packages/@uppy/service-dog/examples/serverless/index.js → packages/@uppy/companion/examples/serverless/index.js

@@ -6,7 +6,7 @@ const cors = require('cors')
 const compression = require('compression')
 const awsServerlessExpress = require('aws-serverless-express')
 const awsServerlessExpressMiddleware = require('aws-serverless-express/middleware')
-const uppy = require('@uppy/service-dog')
+const uppy = require('@uppy/companion')
 
 const app = express()
 

packages/@uppy/service-dog/examples/serverless/package.json → packages/@uppy/companion/examples/serverless/package.json

@@ -7,6 +7,6 @@
     "compression": "^1.7.2",
     "cors": "^2.8.4",
     "express": "^4.16.3",
-    "@uppy/service-dog": "^0.11.2"
+    "@uppy/companion": "^0.11.2"
   }
 }

packages/@uppy/service-dog/infra/kube/service-dog/service-dog-kube.yaml → packages/@uppy/companion/infra/kube/companion/companion-kube.yaml

@@ -1,33 +1,33 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: service-dog
+  name: companion
   namespace: uppy
   labels: 
-    app: service-dog
+    app: companion
 spec:
   ports:
   - port: 80
     targetPort: 3020
     protocol: TCP
   selector:
-    app: service-dog
+    app: companion
 ---
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
-  name: service-dog
+  name: companion
   namespace: uppy
 spec:
   selector:
     matchLabels:
-      app: service-dog
+      app: companion
   replicas: 2
-  serviceName: "service-dog"
+  serviceName: "companion"
   template:
     metadata:
       labels:
-        app: service-dog
+        app: companion
     spec:
       affinity:
         nodeAffinity:
@@ -43,12 +43,12 @@ spec:
               - key: app
                 operator: In
                 values:
-                - service-dog
+                - companion
             topologyKey: kubernetes.io/hostname    
       containers:
-      - image: docker.io/transloadit/service-dog:latest
+      - image: docker.io/transloadit/companion:latest
         imagePullPolicy: Always
-        name: service-dog        
+        name: companion        
         resources:
           limits:
             memory: 2Gi
@@ -56,15 +56,15 @@ spec:
             memory: 2Gi
         envFrom:
         - configMapRef:
-            name: service-dog-env
+            name: companion-env
         ports:
         - containerPort: 3020
         volumeMounts:
-        - name: service-dog-data
-          mountPath: /mnt/service-dog-data
+        - name: companion-data
+          mountPath: /mnt/companion-data
   volumeClaimTemplates:
   - metadata:
-      name: service-dog-data
+      name: companion-data
     spec:
       accessModes: [ "ReadWriteOnce" ]
       storageClassName: "standard"
@@ -75,7 +75,7 @@ spec:
 apiVersion: extensions/v1beta1
 kind: Ingress
 metadata:
-  name: service-dog
+  name: companion
   namespace: uppy
   annotations:
     kubernetes.io/tls-acme: "true"
@@ -87,26 +87,26 @@ spec:
   tls:
   - hosts:
     - server.uppy.io
-    secretName: service-dog-tls
+    secretName: companion-tls
   rules:
   - host: server.uppy.io
     http:
       paths:
       - path: /
         backend:
-          serviceName: service-dog
+          serviceName: companion
           servicePort: 80
 ---
 apiVersion: autoscaling/v1
 kind: HorizontalPodAutoscaler
 metadata:
-  name: service-dog
+  name: companion
   namespace: uppy
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Statefulset
-    name: service-dog
+    name: companion
   minReplicas: 1
   maxReplicas: 5
   targetCPUUtilizationPercentage: 80

packages/@uppy/service-dog/package.json → packages/@uppy/companion/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@uppy/service-dog",
+  "name": "@uppy/companion",
   "version": "0.13.4",
   "description": "Server component for Uppy's (https://uppy.io) extensible file upload widget with support for drag&drop, resumable uploads, previews, restrictions, file processing/encoding, remote providers like Dropbox and Google Drive, S3 and more :dog:",
   "main": "lib/uppy.js",
@@ -26,7 +26,7 @@
     "realtime"
   ],
   "bin": {
-    "service-dog": "./lib/standalone/start-server.js"
+    "companion": "./lib/standalone/start-server.js"
   },
   "devDependencies": {
     "@types/aws-serverless-express": "^3.0.1",
@@ -95,7 +95,7 @@
   },
   "scripts": {
     "build": "tsc -p .",
-    "deploy": "kubectl apply -f infra/kube/service-dog-kube.yml",
+    "deploy": "kubectl apply -f infra/kube/companion-kube.yml",
     "prepublishOnly": "npm run build",
     "start": "node ./lib/standalone/start-server.js",
     "test": "/bin/bash -c 'npm run build && source env.test.sh && jest'",

packages/@uppy/service-dog/src/server/Uploader.js → packages/@uppy/companion/src/server/Uploader.js

@@ -359,7 +359,7 @@ class Uploader {
    */
   _uploadS3 (stream) {
     if (!this.options.s3) {
-      this.emitError(new Error('The S3 client is not configured on this service-dog instance.'))
+      this.emitError(new Error('The S3 client is not configured on this companion instance.'))
       return
     }
 

packages/@uppy/service-dog/src/server/controllers/authorized.js → packages/@uppy/companion/src/server/controllers/authorized.js

@@ -4,7 +4,7 @@
 const logger = require('../logger')
 
 /**
- * checks if service-dog is authorized to access a user's provider account.
+ * checks if companion is authorized to access a user's provider account.
  *
  * @param {object} req
  * @param {object} res

packages/@uppy/service-dog/src/server/emitter/redis-emitter.js → packages/@uppy/companion/src/server/emitter/redis-emitter.js

@@ -3,7 +3,7 @@ const NRP = require('node-redis-pubsub')
 
 /**
  * This class simulates the builtin events.EventEmitter but with the use of redis.
- * This is useful for when service-dog is running on multiple instances and events need
+ * This is useful for when companion is running on multiple instances and events need
  * to be distributed across.
  */
 class RedisEmitter extends NRP {

packages/@uppy/service-dog/src/server/jobs.js → packages/@uppy/companion/src/server/jobs.js

@@ -24,7 +24,7 @@ const cleanUpFinishedUploads = (dirPath) => {
 
     logger.info(`found ${files.length} files`, 'jobs.cleanup.files')
     files.forEach((file, fileIndex) => {
-      // if it does not contain FILE_NAME_PREFIX then it probably wasn't created by service-dog.
+      // if it does not contain FILE_NAME_PREFIX then it probably wasn't created by companion.
       // this is to avoid deleting unintended files, e.g if a wrong path was accidentally given
       // by a developer.
       if (!file.startsWith(FILE_NAME_PREFIX)) {

packages/@uppy/service-dog/src/standalone/helper.js → packages/@uppy/companion/src/standalone/helper.js

@@ -8,7 +8,7 @@ const crypto = require('crypto')
 const { version } = require('../../package.json')
 
 /**
- * Reads all service-dog configuration set via environment variables
+ * Reads all companion configuration set via environment variables
  * and via the config file path
  *
  * @returns {object}
@@ -117,7 +117,7 @@ const getConfigPath = () => {
 }
 
 /**
- * validates that the mandatory service-dog options are set.
+ * validates that the mandatory companion options are set.
  * If it is invalid, it will console an error of unset options and exits the process.
  * If it is valid, nothing happens.
  *
@@ -137,7 +137,7 @@ exports.validateConfig = (config) => {
   // vaidate that all required config is specified
   if (unspecified.length) {
     console.error('\x1b[31m', 'Please specify the following options',
-      'to run service-dog as Standalone:\n', unspecified.join(',\n'), '\x1b[0m')
+      'to run companion as Standalone:\n', unspecified.join(',\n'), '\x1b[0m')
     process.exit(1)
   }
 

packages/@uppy/service-dog/src/standalone/index.js → packages/@uppy/companion/src/standalone/index.js

@@ -81,8 +81,8 @@ app.use((req, res, next) => {
   const protocol = process.env.UPPYSERVER_PROTOCOL || 'http'
 
   // if endpoint urls are specified, then we only allow those endpoints
-  // otherwise, we allow any client url to access service-dog.
-  // here we also enforce that only the protocol allowed by service-dog is used.
+  // otherwise, we allow any client url to access companion.
+  // here we also enforce that only the protocol allowed by companion is used.
   if (process.env.UPPY_ENDPOINTS) {
     const whitelist = process.env.UPPY_ENDPOINTS
       .split(',')

packages/@uppy/service-dog/src/uppy.js → packages/@uppy/companion/src/uppy.js

@@ -36,7 +36,7 @@ const defaultOptions = {
 }
 
 /**
- * Entry point into initializing the service-dog app.
+ * Entry point into initializing the companion app.
  *
  * @param {object} options
  */
@@ -172,7 +172,7 @@ const interceptGrantErrorResponse = interceptor((req, res) => {
       if (body === unwantedBody) {
         logger.error(`grant.js responded with error: ${body}`, 'grant.oauth.error')
         send([
-          'Service-Dog was unable to complete the OAuth process :(',
+          'Companion was unable to complete the OAuth process :(',
           '(Hint, try clearing your cookies and try again)'
         ].join('\n'))
       } else {

tsconfig.json

@@ -23,6 +23,6 @@
     "packages/@uppy/*/types/*-tests.ts",
   ],
   "exclude": [
-    "packages/@uppy/service-dog"
+    "packages/@uppy/companion"
   ]
 }