Update to allow custom fetch client impl

patrick-rodgers · patrick-rodgers · commit 412aa62586ba · 2016-12-30T14:14:34.000-05:00
diff --git a/debug/debug.ts b/debug/debug.ts
@@ -1,6 +1,7 @@
 declare var require: any;
 import pnp from "../src/pnp";
 import { Logger, LogLevel, ConsoleListener } from "../src/utils/logging";
+import { NodeFetchClient } from "../src/net/nodefetchclient";
 
 // setup the connection to SharePoint using the settings file, you can
 // override any of the values as you want here, just be sure not to commit
@@ -12,10 +13,8 @@ let settings = require("../../settings.js");
 
 // configure your node options
 pnp.setup({
-    nodeClientOptions: {
-        clientId: settings.testing.clientId,
-        clientSecret: settings.testing.clientSecret,
-        siteUrl: settings.testing.siteUrl
+    fetchClientFactory: () => {
+        return new NodeFetchClient(settings.testing.siteUrl, settings.testing.clientId, settings.testing.clientSecret);
     }
 });
 
diff --git a/src/configuration/pnplibconfig.ts b/src/configuration/pnplibconfig.ts
@@ -1,12 +1,6 @@
 import { TypedHash } from "../collections/collections";
-
-declare var global: any;
-
-export interface NodeClientData {
-    clientId: string;
-    clientSecret: string;
-    siteUrl: string;
-}
+import { HttpClientImpl } from "../net/httpclient";
+import { FetchClient } from "../net/fetchclient";
 
 export interface LibraryConfiguration {
 
@@ -31,14 +25,9 @@ export interface LibraryConfiguration {
     defaultCachingTimeoutSeconds?: number;
 
     /**
-     * If true the SP.RequestExecutor will be used to make the requests, you must include the required external libs
-     */
-    useSPRequestExecutor?: boolean;
-
-    /**
-     * If set the library will use node-fetch, typically for use with testing but works with any valid client id/secret pair
+     * Defines a factory method used to create fetch clients
      */
-    nodeClientOptions?: NodeClientData;
+    fetchClientFactory: () => HttpClientImpl;
 }
 
 export class RuntimeConfigImpl {
@@ -47,17 +36,15 @@ export class RuntimeConfigImpl {
     private _defaultCachingStore: "session" | "local";
     private _defaultCachingTimeoutSeconds: number;
     private _globalCacheDisable: boolean;
-    private _useSPRequestExecutor: boolean;
-    private _useNodeClient: boolean;
-    private _nodeClientData: NodeClientData;
+    private _fetchClientFactory: () => HttpClientImpl;
 
     constructor() {
         // these are our default values for the library
         this._headers = null;
         this._defaultCachingStore = "session";
         this._defaultCachingTimeoutSeconds = 30;
         this._globalCacheDisable = false;
-        this._useSPRequestExecutor = false;
+        this._fetchClientFactory = () => new FetchClient();
     }
 
     public set(config: LibraryConfiguration): void {
@@ -78,19 +65,8 @@ export class RuntimeConfigImpl {
             this._defaultCachingTimeoutSeconds = config.defaultCachingTimeoutSeconds;
         }
 
-        if (config.hasOwnProperty("useSPRequestExecutor")) {
-            this._useSPRequestExecutor = config.useSPRequestExecutor;
-        }
-
-        if (config.hasOwnProperty("nodeClientOptions")) {
-            this._useNodeClient = true;
-            this._useSPRequestExecutor = false; // just don't allow this conflict
-            this._nodeClientData = config.nodeClientOptions;
-            // this is to help things work when running in node.js, specifically batching
-            // we shim the _spPageContextInfo object
-            global._spPageContextInfo = {
-                webAbsoluteUrl: config.nodeClientOptions.siteUrl,
-            };
+        if (config.hasOwnProperty("fetchClientFactory")) {
+            this._fetchClientFactory = config.fetchClientFactory;
         }
     }
 
@@ -110,16 +86,8 @@ export class RuntimeConfigImpl {
         return this._globalCacheDisable;
     }
 
-    public get useSPRequestExecutor(): boolean {
-        return this._useSPRequestExecutor;
-    }
-
-    public get useNodeFetchClient(): boolean {
-        return this._useNodeClient;
-    }
-
-    public get nodeRequestOptions(): NodeClientData {
-        return this._nodeClientData;
+    public get fetchClientFactory(): () => HttpClientImpl {
+        return this._fetchClientFactory;
     }
 }
 
diff --git a/src/net/httpclient.ts b/src/net/httpclient.ts
@@ -1,9 +1,6 @@
-import { FetchClient } from "./fetchclient";
 import { DigestCache } from "./digestcache";
 import { Util } from "../utils/util";
 import { RuntimeConfig } from "../configuration/pnplibconfig";
-import { SPRequestExecutorClient } from "./sprequestexecutorclient";
-import { NodeFetchClient } from "./nodefetchclient";
 import { APIUrlException } from "../utils/exceptions";
 
 export interface FetchOptions {
@@ -21,7 +18,7 @@ export class HttpClient {
     private _impl: HttpClientImpl;
 
     constructor() {
-        this._impl = this.getFetchImpl();
+        this._impl = RuntimeConfig.fetchClientFactory();
         this._digestCache = new DigestCache(this);
     }
 
@@ -138,17 +135,6 @@ export class HttpClient {
         return this.fetch(url, opts);
     }
 
-    protected getFetchImpl(): HttpClientImpl {
-        if (RuntimeConfig.useSPRequestExecutor) {
-            return new SPRequestExecutorClient();
-        } else if (RuntimeConfig.useNodeFetchClient) {
-            let opts = RuntimeConfig.nodeRequestOptions;
-            return new NodeFetchClient(opts.siteUrl, opts.clientId, opts.clientSecret);
-        } else {
-            return new FetchClient();
-        }
-    }
-
     private mergeHeaders(target: Headers, source: any): void {
         if (typeof source !== "undefined" && source !== null) {
             let temp = <any>new Request("", { headers: source });
diff --git a/src/net/nodefetchclient.ts b/src/net/nodefetchclient.ts
@@ -29,6 +29,9 @@ export class NodeFetchClient implements HttpClientImpl {
         global.Headers = nodeFetch.Headers;
         global.Request = nodeFetch.Request;
         global.Response = nodeFetch.Response;
+        global._spPageContextInfo = {
+            webAbsoluteUrl: siteUrl,
+        };
     }
 
     public fetch(url: string, options: any): Promise<Response> {
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -1,8 +1,10 @@
 export * from "../sharepoint/index";
 export { FetchOptions, HttpClient } from "../net/httpclient";
+export { SPRequestExecutorClient } from "../net/sprequestexecutorclient";
+export { NodeFetchClient } from "../net/nodefetchclient";
 export { IConfigurationProvider } from "../configuration/configuration";
 export * from "../configuration/providers/index";
-export { NodeClientData, LibraryConfiguration } from "../configuration/pnplibconfig";
+export { LibraryConfiguration } from "../configuration/pnplibconfig";
 export { TypedHash, Dictionary } from "../collections/collections";
 export { Util } from "../utils/util";
 export * from "../utils/logging";
diff --git a/webpack-serve.config.js b/webpack-serve.config.js
@@ -18,7 +18,7 @@ module.exports = {
         extensions: ['', '.ts']
     },
     plugins: [
-        new webpack.NormalModuleReplacementPlugin(/\.\/nodefetchclient/, "./nodefetchclientbrowser"),
+        new webpack.NormalModuleReplacementPlugin(/\.\.\/net\/nodefetchclient/, "../net/nodefetchclientbrowser"),
     ],
     module: {
         loaders: [
diff --git a/webpack.config.js b/webpack.config.js
@@ -18,7 +18,7 @@ module.exports = [{
         extensions: ['', '.js']
     },
     plugins: [
-        new webpack.NormalModuleReplacementPlugin(/\.\/nodefetchclient/, "./nodefetchclientbrowser"),
+        new webpack.NormalModuleReplacementPlugin(/\.\.\/net\/nodefetchclient/, "../net/nodefetchclientbrowser"),
         new webpack.BannerPlugin(config.header, { entryOnly: true, raw: true })
     ],
     module: {
@@ -43,7 +43,7 @@ module.exports = [{
         extensions: ['', '.js']
     },
     plugins: [
-        new webpack.NormalModuleReplacementPlugin(/\.\/nodefetchclient/, "./nodefetchclientbrowser"),
+        new webpack.NormalModuleReplacementPlugin(/\.\.\/net\/nodefetchclient/, "../net/nodefetchclientbrowser"),
         new webpack.BannerPlugin(config.header, { entryOnly: true, raw: true }),
         new webpack.DefinePlugin({
             "process.env": {

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@ export class NodeFetchClient implements HttpClientImpl {`
`29`	`29`	`global.Headers = nodeFetch.Headers;`
`30`	`30`	`global.Request = nodeFetch.Request;`
`31`	`31`	`global.Response = nodeFetch.Response;`
	`32`	`+ global._spPageContextInfo = {`
	`33`	`+ webAbsoluteUrl: siteUrl,`
	`34`	`+ };`
`32`	`35`	`}`
`33`	`36`
`34`	`37`	`public fetch(url: string, options: any): Promise<Response> {`